MongoDB Atlas Administration API
API docs by Redocly

MongoDB Atlas Administration API (1.0)

Download OpenAPI specification:Download

URL: https://www.mongodb.com/support/get-started License: SSPL Terms of Service

The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas. To learn more, review the Administration API overview. This OpenAPI specification covers all of the collections with the exception of Alerts, Alert Configurations, and Events. Refer to the legacy documentation for the specifications of these resources.

Access Tracking

Returns access logs for authentication attempts made to MongoDB Cloud database deployments.

Return Database Access History for One Cluster using Its Cluster Name

Returns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role.

Database Access History
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

authResult
boolean

Flag that indicates whether the response returns the successful authentication attempts only.

end
string

Date and time when to stop retrieving database history. If you specify end, you must also specify start. This parameter uses the ISO 8601 timestamp format in UTC.

ipAddress
string^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...

One Internet Protocol address that attempted to authenticate with the database.

nLogs
number [ 0 .. 20000 ]
Default: 20000

Maximum number of lines from the log to return.
start
string <date-time> ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Date and time when MongoDB Cloud begins retrieving database history. If you specify start, you must also specify end. This parameter uses the ISO 8601 timestamp format in UTC.

Responses

Response samples

Content type
application/json
{
  • "accessLogs": [
    ]
}

Return Database Access History for One Cluster using Its Hostname

Returns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role.

Database Access History
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

hostname
required
string

Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

authResult
boolean

Flag that indicates whether the response returns the successful authentication attempts only.

end
string <date-time> ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Date and time when to stop retrieving database history. If you specify end, you must also specify start. This parameter uses the ISO 8601 timestamp format in UTC.

ipAddress
string^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...

One Internet Protocol address that attempted to authenticate with the database.

nLogs
number [ 0 .. 20000 ]
Default: 20000

Maximum number of lines from the log to return.
start
string <date-time> ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Date and time when MongoDB Cloud begins retrieving database history. If you specify start, you must also specify end. This parameter uses the ISO 8601 timestamp format in UTC.

Responses

Response samples

Content type
application/json
{
  • "accessLogs": [
    ]
}

Alert Configurations

Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change. Refer to the legacy documentation for this collection in the following link.

Alert Configurations API Legacy Documentation

Get All Alert Configuration Matchers Field Names

Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
[
  • "TYPE_NAME"
]

Return All Alert Configurations for One Project

Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

This resource remains under revision and may change. Refer to the legacy documentation for this resource.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "links": [ ],
  • "results": [
    ],
  • "totalCount": 0
}

Create One Alert Configuration in One Project

Creates one alert configuration for the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Project Monitoring Admin role.

This resource remains under revision and may change. Refer to the legacy documentation for this resource.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Creates one alert configuration for the specified project.

enabled
boolean
Default: false

Flag that indicates whether someone enabled this alert configuration for the specified project.

eventTypeName
required
string
Enum: "AWS_ENCRYPTION_KEY_NEEDS_ROTATION" "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION" "CLUSTER_MONGOS_IS_MISSING" "CPS_RESTORE_FAILED" "CPS_RESTORE_SUCCESSFUL" "CPS_SNAPSHOT_BEHIND" "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED" "CPS_SNAPSHOT_FALLBACK_FAILED" "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL" "CPS_SNAPSHOT_SUCCESSFUL" "CREDIT_CARD_ABOUT_TO_EXPIRE" "DAILY_BILL_OVER_THRESHOLD" "GCP_ENCRYPTION_KEY_NEEDS_ROTATION" "HOST_DOWN" "JOINED_GROUP" "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK" "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" "NO_PRIMARY" "OUTSIDE_METRIC_THRESHOLD" "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" "OUTSIDE_REALM_METRIC_THRESHOLD" "PENDING_INVOICE_OVER_THRESHOLD" "PRIMARY_ELECTED" "REMOVED_FROM_GROUP" "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" "TOO_MANY_ELECTIONS" "USER_ROLES_CHANGED_AUDIT" "USERS_WITHOUT_MULTIFACTOR_AUTH"

Event type that triggers an alert.
Array of objects (Matchers)

List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the eventTypeName specifies an event for a host, replica set, or sharded cluster.

object (Metric Threshold)

Threshold for the metric that, when exceeded, triggers an alert. The resource returns this parameter when "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD".

Array of objects (Notifications)

List that contains the targets that MongoDB Cloud sends notifications.

object (Threshold)

Limit that triggers an alert when exceeded. The resource returns this parameter when eventTypeName has not been set to OUTSIDE_METRIC_THRESHOLD.

Responses

Request samples

Content type
application/json
{
  • "enabled": false,
  • "eventTypeName": "AWS_ENCRYPTION_KEY_NEEDS_ROTATION",
  • "matchers": [
    ],
  • "metricThreshold": {
    },
  • "notifications": [
    ],
  • "threshold": {
    }
}

Response samples

Content type
application/json
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "AWS_ENCRYPTION_KEY_NEEDS_ROTATION",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "adddde5af4ee4bd0b519375f",
  • "links": [ ],
  • "matchers": [
    ],
  • "metricThreshold": {
    },
  • "notifications": [
    ],
  • "threshold": {
    },
  • "typeName": "string",
  • "updated": "2019-08-24T14:15:22Z"
}

Remove One Alert Configuration from One Project

Removes one alert configuration from the specified project. To use this resource, the requesting API Key must have the Project Monitoring Admin role.

This resource remains under revision and may change. Refer to the legacy documentation for this resource.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

alertConfigId
required
string = 24 characters ^([a-f0-9]{24})$
Example: adddde5af4ee4bd0b519375f

Unique 24-hexadecimal digit string that identifies the alert configuration.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "parameters": [
    ],
  • "reason": "Unauthorized"
}

Return One Alert Configuration from One Project

Returns the specified alert configuration from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

This resource remains under revision and may change. Refer to the legacy documentation for this resource.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

alertConfigId
required
string = 24 characters ^([a-f0-9]{24})$
Example: adddde5af4ee4bd0b519375f

Unique 24-hexadecimal digit string that identifies the alert configuration.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "AWS_ENCRYPTION_KEY_NEEDS_ROTATION",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "adddde5af4ee4bd0b519375f",
  • "links": [ ],
  • "matchers": [
    ],
  • "metricThreshold": {
    },
  • "notifications": [
    ],
  • "threshold": {
    },
  • "typeName": "string",
  • "updated": "2019-08-24T14:15:22Z"
}

Toggle One State of One Alert Configuration in One Project

Enables or disables the specified alert configuration in the specified project. The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting API Key must have the Project Monitoring Admin role.

This resource remains under revision and may change. Refer to the legacy documentation for this resource.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

alertConfigId
required
string = 24 characters ^([a-f0-9]{24})$
Example: adddde5af4ee4bd0b519375f

Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Enables or disables the specified alert configuration in the specified project.

boolean

Flag that indicates whether to enable or disable the specified alert configuration in the specified project.

Responses

Request samples

Content type
application/json
true

Response samples

Content type
application/json
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "AWS_ENCRYPTION_KEY_NEEDS_ROTATION",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "adddde5af4ee4bd0b519375f",
  • "links": [ ],
  • "matchers": [
    ],
  • "metricThreshold": {
    },
  • "notifications": [
    ],
  • "threshold": {
    },
  • "typeName": "string",
  • "updated": "2019-08-24T14:15:22Z"
}

Update One Alert Configuration for One Project

Updates one alert configuration in the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Project Monitoring Admin role.

This resource remains under revision and may change. Refer to the legacy documentation for this resource.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

alertConfigId
required
string = 24 characters ^([a-f0-9]{24})$
Example: adddde5af4ee4bd0b519375f

Unique 24-hexadecimal digit string that identifies the alert configuration.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Updates one alert configuration in the specified project.

enabled
boolean
Default: false

Flag that indicates whether someone enabled this alert configuration for the specified project.

eventTypeName
required
string
Enum: "AWS_ENCRYPTION_KEY_NEEDS_ROTATION" "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION" "CLUSTER_MONGOS_IS_MISSING" "CPS_RESTORE_FAILED" "CPS_RESTORE_SUCCESSFUL" "CPS_SNAPSHOT_BEHIND" "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED" "CPS_SNAPSHOT_FALLBACK_FAILED" "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL" "CPS_SNAPSHOT_SUCCESSFUL" "CREDIT_CARD_ABOUT_TO_EXPIRE" "DAILY_BILL_OVER_THRESHOLD" "GCP_ENCRYPTION_KEY_NEEDS_ROTATION" "HOST_DOWN" "JOINED_GROUP" "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK" "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" "NO_PRIMARY" "OUTSIDE_METRIC_THRESHOLD" "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" "OUTSIDE_REALM_METRIC_THRESHOLD" "PENDING_INVOICE_OVER_THRESHOLD" "PRIMARY_ELECTED" "REMOVED_FROM_GROUP" "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" "TOO_MANY_ELECTIONS" "USER_ROLES_CHANGED_AUDIT" "USERS_WITHOUT_MULTIFACTOR_AUTH"

Event type that triggers an alert.
Array of objects (Matchers)

List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the eventTypeName specifies an event for a host, replica set, or sharded cluster.

object (Metric Threshold)

Threshold for the metric that, when exceeded, triggers an alert. The resource returns this parameter when "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD".

Array of objects (Notifications)

List that contains the targets that MongoDB Cloud sends notifications.

object (Threshold)

Limit that triggers an alert when exceeded. The resource returns this parameter when eventTypeName has not been set to OUTSIDE_METRIC_THRESHOLD.

Responses

Request samples

Content type
application/json
{
  • "enabled": false,
  • "eventTypeName": "AWS_ENCRYPTION_KEY_NEEDS_ROTATION",
  • "matchers": [
    ],
  • "metricThreshold": {
    },
  • "notifications": [
    ],
  • "threshold": {
    }
}

Response samples

Content type
application/json
{
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": false,
  • "eventTypeName": "AWS_ENCRYPTION_KEY_NEEDS_ROTATION",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "adddde5af4ee4bd0b519375f",
  • "links": [ ],
  • "matchers": [
    ],
  • "metricThreshold": {
    },
  • "notifications": [
    ],
  • "threshold": {
    },
  • "typeName": "string",
  • "updated": "2019-08-24T14:15:22Z"
}

Return All Open Alerts for Alert Configuration

Returns all open alerts that the specified alert configuration triggers. These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting API Key must have the Project Read Only role.

This resource remains under revision and may change. Refer to the legacy documentation for this resource.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

alertConfigId
required
string = 24 characters ^([a-f0-9]{24})$
Example: adddde5af4ee4bd0b519375f

Unique 24-hexadecimal digit string that identifies the alert configuration.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Alerts

Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. This collection remains under revision and may change. Refer to the legacy documentation for this collection in the following link.

Alerts API Legacy Documentation

Return All Alerts from One Project

Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

This resource remains under revision and may change. Refer to the legacy documentation for this resource.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Return One Alert from One Project

Returns one alert. This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

This resource remains under revision and may change. Refer to the legacy documentation for this resource.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

alertId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the alert.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "acknowledgedUntil": "2019-08-24T14:15:22Z",
  • "acknowledgementComment": "string",
  • "acknowledgingUsername": "user@example.com",
  • "alertConfigId": "adddde5af4ee4bd0b519375f",
  • "clusterName": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "currentValue": {
    },
  • "eventTypeName": "AWS_ENCRYPTION_KEY_NEEDS_ROTATION",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostnameAndPort": "string",
  • "id": "d268e3a6e1718c6c36376f73",
  • "lastNotified": "2019-08-24T14:15:22Z",
  • "links": [ ],
  • "metricName": "ASSERT_MSG",
  • "replicaSetName": "string",
  • "resolved": "2019-08-24T14:15:22Z",
  • "status": "CANCELLED",
  • "typeName": "string",
  • "updated": "2019-08-24T14:15:22Z"
}

Acknowledge One Alert from One Project

Confirms receipt of one existing alert. This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting API Key must have the Project Monitoring Admin role. This resource doesn't require the API Key to have an Access List.

This resource remains under revision and may change. Refer to the legacy documentation for this resource.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

alertId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the alert.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Confirm one alert.

acknowledgedUntil
required
string <date-time> ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.

  • To acknowledge this alert forever, set the parameter value to 100 years in the future.

  • To unacknowledge a previously acknowledged alert, set the parameter value to a date in the past.

acknowledgementComment
string <= 200 characters

Comment that a MongoDB Cloud user submitted when acknowledging the alert.

Responses

Request samples

Content type
application/json
{
  • "acknowledgedUntil": "2019-08-24T14:15:22Z",
  • "acknowledgementComment": "string"
}

Response samples

Content type
application/json
{
  • "acknowledgedUntil": "2019-08-24T14:15:22Z",
  • "acknowledgementComment": "string",
  • "acknowledgingUsername": "user@example.com",
  • "alertConfigId": "adddde5af4ee4bd0b519375f",
  • "clusterName": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "currentValue": {
    },
  • "eventTypeName": "AWS_ENCRYPTION_KEY_NEEDS_ROTATION",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "hostnameAndPort": "string",
  • "id": "d268e3a6e1718c6c36376f73",
  • "lastNotified": "2019-08-24T14:15:22Z",
  • "links": [ ],
  • "metricName": "ASSERT_MSG",
  • "replicaSetName": "string",
  • "resolved": "2019-08-24T14:15:22Z",
  • "status": "CANCELLED",
  • "typeName": "string",
  • "updated": "2019-08-24T14:15:22Z"
}

Return All Alert Configurations Set for One Alert

Returns all alert configurations set for the specified alert. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

This resource remains under revision and may change.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

alertId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the alert.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

Responses

Response samples

Content type
application/json
{
  • "links": [ ],
  • "results": [
    ],
  • "totalCount": 0
}

Return All User-Defined Analyzers for One Cluster

Returns all Atlas Search custom analyzers that the specified cluster uses in the specified project. Custom analyzers define the operations to perform to index a field. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This resource doesn't require the API Key to have an Access List.

Custom Analyzers
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Name of the cluster that contains the collection with one or more Atlas Search indexes.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update All User-Defined Analyzers for One Cluster

Updates one or more Atlas Search custom analyzers on the specified cluster. Custom analyzers define the operations to perform to index a field. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.

Custom Analyzers
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Name of the cluster that contains the collection with one or more Atlas Search indexes.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Updates one or more Atlas Search custom analyzers on the specified cluster.

Array
Array of htmlStrip (object) or icuNormalize (object) or mapping (object) or persian (object)

Filters that examine text one character at a time and perform filtering operations.

name
required
string

Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:

  • lucene.
  • builtin.
  • mongodb.
Array of asciiFolding (object) or daitchMokotoffSoundex (object) or edgeGram (object) or icuFolding (object) or icuNormalizer (object) or length (object) or lowercase (object) or nGram (object) or regex (object) or reverse (object) or shingle (object) or snowballStemming (object) or stopword (object) or trim (object)

Filter that performs operations such as:

  • Stemming, which reduces related words, such as "talking", "talked", and "talks" to their root word "talk".

  • Redaction, the removal of sensitive information from public documents.

required
edgeGram (object) or keyword (object) or nGram (object) or regexCaptureGroup (object) or regexSplit (object) or standard (object) or uaxUrlEmail (object) or whitespace (object)

Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Create One Atlas Search Index

Creates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.

Atlas Search Indexes
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Name of the cluster that contains the collection on which to create an Atlas Search index.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Creates one Atlas Search index on the specified collection.

analyzer
string
Default: "lucene.standard"
Enum: "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" "lucene.arabic" "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" "lucene.danish" "lucene.dutch" "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" "lucene.irish" "lucene.italian" "lucene.japanese" "lucene.korean" "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian" "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian"

Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a term or token. This process, known as tokenization, involves a variety of changes made to the text in fields:

  • extracting words
  • removing punctuation
  • removing accents
  • changing to lowercase
  • removing common words
  • reducing words to their root form (stemming)
  • changing words to their base form (lemmatization) MongoDB Cloud uses the selected process to build the Atlas Search index.
Atlas Search Analyzers
Array of objects (analyzers)

List of user-defined methods to convert database field text into searchable words.

Custom Atlas Search Analyzers
collectionName
required
string

Human-readable label that identifies the collection that contains one or more Atlas Search indexes.

database
required
string

Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.

object (mappings)

Index specifications for the collection's fields.
name
required
string

Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique.

searchAnalyzer
string
Default: "lucene.standard"
Enum: "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" "lucene.arabic" "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" "lucene.danish" "lucene.dutch" "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" "lucene.irish" "lucene.italian" "lucene.japanese" "lucene.korean" "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian" "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian"

Method applied to identify words when searching this index.
Array of objects (Synonym Mapping Definition)

Rule sets that map words to their synonyms in this index.

Synonym Mapping

Responses

Request samples

Content type
application/json
{
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "collectionName": "string",
  • "database": "string",
  • "mappings": {
    },
  • "name": "string",
  • "searchAnalyzer": "lucene.standard",
  • "synonyms": [
    ]
}

Response samples

Content type
application/json
{
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "2dc22bf163e2f83527cc3838",
  • "mappings": {
    },
  • "name": "string",
  • "searchAnalyzer": "lucene.standard",
  • "status": "FAILED",
  • "synonyms": [
    ]
}

Return All Atlas Search Indexes for One Collection

Returns all Atlas Search indexes on the specified collection. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This resource doesn't require the API Key to have an Access List.

Atlas Search Indexes
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Name of the cluster that contains the collection with one or more Atlas Search indexes.

collectionName
required
string

Name of the collection that contains one or more Atlas Search indexes.

databaseName
required
string

Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Remove One Atlas Search Index

Removes one Atlas Search index that you identified with its unique ID. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.

Atlas Search Indexes
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Name of the cluster that contains the database and collection with one or more Application Search indexes.

indexId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the Get All Atlas Search Indexes for a Collection API endpoint to find the IDs of all Atlas Search indexes.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Atlas Search Index

Returns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This resource doesn't require the API Key to have an Access List.

Atlas Search Indexes
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Name of the cluster that contains the collection with one or more Atlas Search indexes.

indexId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the Application Search index. Use the Get All Application Search Indexes for a Collection API endpoint to find the IDs of all Application Search indexes.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "2dc22bf163e2f83527cc3838",
  • "mappings": {
    },
  • "name": "string",
  • "searchAnalyzer": "lucene.standard",
  • "status": "FAILED",
  • "synonyms": [
    ]
}

Update One Atlas Search Index

Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.

Atlas Search Indexes
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Name of the cluster that contains the collection whose Atlas Search index to update.

indexId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the Get All Atlas Search Indexes for a Collection API endpoint to find the IDs of all Atlas Search indexes.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Details to update on the Atlas Search index.

analyzer
string
Default: "lucene.standard"
Enum: "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" "lucene.arabic" "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" "lucene.danish" "lucene.dutch" "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" "lucene.irish" "lucene.italian" "lucene.japanese" "lucene.korean" "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian" "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian"

Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a term or token. This process, known as tokenization, involves a variety of changes made to the text in fields:

  • extracting words
  • removing punctuation
  • removing accents
  • changing to lowercase
  • removing common words
  • reducing words to their root form (stemming)
  • changing words to their base form (lemmatization) MongoDB Cloud uses the selected process to build the Atlas Search index.
Atlas Search Analyzers
Array of objects (analyzers)

List of user-defined methods to convert database field text into searchable words.

Custom Atlas Search Analyzers
collectionName
required
string

Human-readable label that identifies the collection that contains one or more Atlas Search indexes.

database
required
string

Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes.

object (mappings)

Index specifications for the collection's fields.
name
required
string

Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique.

searchAnalyzer
string
Default: "lucene.standard"
Enum: "lucene.standard" "lucene.simple" "lucene.whitespace" "lucene.keyword" "lucene.arabic" "lucene.armenian" "lucene.basque" "lucene.bengali" "lucene.brazilian" "lucene.bulgarian" "lucene.catalan" "lucene.chinese" "lucene.cjk" "lucene.czech" "lucene.danish" "lucene.dutch" "lucene.english" "lucene.finnish" "lucene.french" "lucene.galician" "lucene.german" "lucene.greek" "lucene.hindi" "lucene.hungarian" "lucene.indonesian" "lucene.irish" "lucene.italian" "lucene.japanese" "lucene.korean" "lucene.kuromoji" "lucene.latvian" "lucene.lithuanian" "lucene.morfologik" "lucene.nori" "lucene.norwegian" "lucene.persian" "lucene.portuguese" "lucene.romanian" "lucene.russian" "lucene.smartcn" "lucene.sorani" "lucene.spanish" "lucene.swedish" "lucene.thai" "lucene.turkish" "lucene.ukrainian"

Method applied to identify words when searching this index.
Array of objects (Synonym Mapping Definition)

Rule sets that map words to their synonyms in this index.

Synonym Mapping

Responses

Request samples

Content type
application/json
{
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "collectionName": "string",
  • "database": "string",
  • "mappings": {
    },
  • "name": "string",
  • "searchAnalyzer": "lucene.standard",
  • "synonyms": [
    ]
}

Response samples

Content type
application/json
{
  • "analyzer": "lucene.standard",
  • "analyzers": [
    ],
  • "collectionName": "string",
  • "database": "string",
  • "indexID": "2dc22bf163e2f83527cc3838",
  • "mappings": {
    },
  • "name": "string",
  • "searchAnalyzer": "lucene.standard",
  • "status": "FAILED",
  • "synonyms": [
    ]
}

Auditing

Returns and edits database auditing settings for MongoDB Cloud projects.

Return the Auditing Configuration for One Project

Returns the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "auditAuthorizationSuccess": false,
  • "auditFilter": "string",
  • "configurationType": "FILTER_BUILDER",
  • "enabled": false
}

Update Auditing Configuration for One Project

Updates the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Updated auditing configuration for the specified project.

auditAuthorizationSuccess
required
boolean
Default: false

Flag that indicates whether someone set auditing to track successful authentications. This only applies to the "atype" : "authCheck" audit filter. Setting this parameter to true degrades cluster performance.

System Auditing Messages
auditFilter
required
string

JSON document that specifies which events to record. Escape any characters that may prevent parsing, such as single or double quotes, using a backslash (\).

Custom Auditing Filter
enabled
required
boolean
Default: false

Flag that indicates whether someone enabled database auditing for the specified project.

Responses

Request samples

Content type
application/json
{
  • "auditAuthorizationSuccess": false,
  • "auditFilter": "string",
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "auditAuthorizationSuccess": false,
  • "auditFilter": "string",
  • "configurationType": "FILTER_BUILDER",
  • "enabled": false
}

Cloud Backups

Returns, takes, and removes Cloud Backup snapshots.

Return All Replica Set Cloud Backups

Returns all snapshots of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Take One On-Demand Snapshot

Takes one on-demand snapshot for the specified cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Takes one on-demand snapshot.

description
string

Human-readable phrase or sentence that explains the purpose of the snapshot. The resource returns this parameter when "status" : "onDemand".

retentionInDays
number >= 1

Number of days that MongoDB Cloud should retain the on-demand snapshot. Must be at least 1

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "retentionInDays": 1
}

Response samples

Content type
application/json
Example
{ }

Remove One Sharded Cluster Cloud Backup

Removes one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
snapshotId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the desired snapshot.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  • "error": 404,
  • "errorCode": "RESOURCE_NOT_FOUND",
  • "parameters": [
    ],
  • "reason": "Not Found"
}

Return One Sharded Cluster Cloud Backup

Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
snapshotId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the desired snapshot.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "78e18e587716102f711a5bca",
  • "links": [ ],
  • "masterKeyUUID": "72659f08-8b3c-4913-bb4e-a8a68e036502",
  • "members": [
    ],
  • "mongodVersion": "string",
  • "policyItems": [
    ],
  • "snapshotIds": [
    ],
  • "snapshotType": "onDemand",
  • "status": "queued",
  • "storageSizeBytes": 0,
  • "type": "REPLICA_SET"
}

Return All Sharded Cluster Cloud Backups

Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Remove One Replica Set Cloud Backup

Removes rhe specified snapshot. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
snapshotId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the desired snapshot.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Replica Set Cloud Backup

Returns one snapshot from the specified cluster. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
snapshotId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the desired snapshot.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Return All Snapshots of One Serverless Instance

Returns all snapshots of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the serverless instance.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

Responses

Response samples

Content type
application/json
[ ]

Return One Snapshot of One Serverless Instance

Returns one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the serverless instance.
snapshotId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 78e18e587716102f711a5bca

Unique 24-hexadecimal digit string that identifies the desired snapshot.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "frequencyType": "hourly",
  • "id": "78e18e587716102f711a5bca",
  • "mongodVersion": "5.0.3",
  • "serverlessInstanceName": "string",
  • "snapshotType": "onDemand",
  • "status": "queued",
  • "storageSizeBytes": 0
}

Cloud Backup Export

Returns, adds, and removes Cloud Backup snapshot export buckets. Also returns and adds Cloud Backup export jobs.

Return All AWS S3 Buckets Used for Cloud Backup Snapshot Exports

Returns all AWS S3 buckets associated with the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Grant Access to AWS S3 Bucket for Cloud Backup Snapshot Exports

Grants MongoDB Cloud access to the specified AWS S3 bucket. This enables this bucket to receive Atlas Cloud Backup snapshots. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Grants MongoDB Cloud access to the specified AWS S3 bucket.

bucketName
string

Human-readable label that identifies the AWS bucket that the role is authorized to access.

cloudProvider
string
Enum: "AWS" "AZURE" "GCP"

Human-readable label that identifies the cloud provider that stores this snapshot.

iamRoleId
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal character string that identifies the AWS IAM role that MongoDB Cloud uses to access the AWS S3 bucket.

Responses

Request samples

Content type
application/json
{
  • "bucketName": "string",
  • "cloudProvider": "AWS",
  • "iamRoleId": "3ede41953aba3592851299c1"
}

Response samples

Content type
application/json
{ }

Revoke Access to AWS S3 Bucket for Cloud Backup Snapshot Exports

Revoke MongoDB Cloud access to the specified AWS S3 bucket. This prevents this bucket to receive Atlas Cloud Backup snapshots. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

exportBucketId
required
string [ 3 .. 63 ] characters ^((?!xn--)(?!.*-s3alias)[a-z0-9][a-z0-9-]{1,6...

Unique string that identifies the AWS S3 bucket to which you export your snapshots.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One AWS S3 Bucket Used for Cloud Backup Snapshot Exports

Returns one AWS S3 bucket associated with the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

exportBucketId
required
string [ 3 .. 63 ] characters ^((?!xn--)(?!.*-s3alias)[a-z0-9][a-z0-9-]{1,6...

Unique string that identifies the AWS S3 bucket to which you export your snapshots.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{ }

Return All Cloud Backup Snapshot Export Jobs

Returns all Cloud Backup snapshot export jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

Responses

Response samples

Content type
application/json
[ ]

Create One Cloud Backup Snapshot Export Job

Exports one backup snapshot for dedicated Atlas cluster using Cloud Backups to an AWS bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Request Body schema: application/json
Array of objects (customData)

Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.

exportBucketId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal character string that identifies the AWS bucket to which MongoDB Cloud exports the Cloud Backup snapshot.

snapshotId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal character string that identifies the Cloud Backup snasphot to export.

Responses

Request samples

Content type
application/json
{
  • "customData": [
    ],
  • "exportBucketId": "d705ef7f03974e8363ffee5d",
  • "snapshotId": "78e18e587716102f711a5bca"
}

Response samples

Content type
application/json
{ }

Return One Cloud Backup Snapshot Export Job

Returns one Cloud Backup snapshot export job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
exportId
required
string

Unique string that identifies the AWS S3 bucket to which you export your snapshots.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{ }

Cloud Backup Restore Jobs

Returns, starts, and cancels Cloud Backup restore jobs.

Return All Restore Jobs for One Cluster

Returns all cloud backup restore jobs for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster with the restore jobs you want to return.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Restore One Snapshot of One Cluster

Restores one snapshot of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Restores one snapshot of one cluster from the specified project.

deliveryType
required
string
Enum: "automated" "download" "pointInTime"

Human-readable label that categorizes the restore job to create.

oplogInc
integer <int32> >= 1

Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when "deliveryType" : "pointInTime" and oplogTs exceeds 0.

oplogTs
integer <int32> >= 1199145600

Date and time from which you want to restore this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. This number represents the first part of an Oplog timestamp. The resource returns this parameter when "deliveryType" : "pointInTime" and oplogTs exceeds 0.

pointInTimeUTCSeconds
number >= 1199145600

Date and time from which MongoDB Cloud restored this snapshot. This parameter expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. The resource returns this parameter when "deliveryType" : "pointInTime" and pointInTimeUTCSeconds exceeds 0.

snapshotId
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal character string that identifies the snapshot.

targetClusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when "deliveryType": "automated".

targetGroupId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the target project for the specified targetClusterName.

Responses

Request samples

Content type
application/json
{
  • "deliveryType": "automated",
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "78e18e587716102f711a5bca",
  • "targetClusterName": "string",
  • "targetGroupId": "ca4d8a18b96b317422974eec"
}

Response samples

Content type
application/json
{
  • "cancelled": true,
  • "components": [
    ],
  • "deliveryType": "automated",
  • "deliveryUrl": [
    ],
  • "desiredTimestamp": { },
  • "expired": true,
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failed": true,
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "e7cb93f480f357b5139ccf37",
  • "links": [ ],
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "78e18e587716102f711a5bca",
  • "targetClusterName": "string",
  • "targetGroupId": "ca4d8a18b96b317422974eec",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Cancel One Restore Job of One Cluster

Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
restoreJobId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the restore job to remove.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Restore Job of One Cluster

Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster with the restore jobs you want to return.

restoreJobId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the restore job to return.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "cancelled": true,
  • "components": [
    ],
  • "deliveryType": "automated",
  • "deliveryUrl": [
    ],
  • "desiredTimestamp": { },
  • "expired": true,
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failed": true,
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "e7cb93f480f357b5139ccf37",
  • "links": [ ],
  • "oplogInc": 1,
  • "oplogTs": 1199145600,
  • "pointInTimeUTCSeconds": 1199145600,
  • "snapshotId": "78e18e587716102f711a5bca",
  • "targetClusterName": "string",
  • "targetGroupId": "ca4d8a18b96b317422974eec",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Return All Restore Jobs for One Serverless Instance

Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the serverless instance.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Restore One Snapshot of One Serverless Instance

Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the serverless instance whose snapshot you want to restore.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Restores one snapshot of one serverless instance from the specified project.

deliveryType
required
string
Enum: "automated" "download" "pointInTime"

Human-readable label that categorizes the restore job to create.

snapshotId
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal character string that identifies the snapshot.

targetClusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the target cluster to which the restore job restores the snapshot. The resource returns this parameter when "deliveryType": "automated".

targetGroupId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the target project for the specified targetClusterName.

Responses

Request samples

Content type
application/json
{
  • "deliveryType": "automated",
  • "snapshotId": "78e18e587716102f711a5bca",
  • "targetClusterName": "string",
  • "targetGroupId": "ca4d8a18b96b317422974eec"
}

Response samples

Content type
application/json
{
  • "cancelled": true,
  • "deliveryType": "automated",
  • "deliveryUrl": [
    ],
  • "desiredTimestamp": { },
  • "expired": true,
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failed": true,
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "e7cb93f480f357b5139ccf37",
  • "snapshotId": "78e18e587716102f711a5bca",
  • "targetClusterName": "string",
  • "targetGroupId": "ca4d8a18b96b317422974eec",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Return One Restore Job for One Serverless Instance

Returns one restore job for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the serverless instance.
restoreJobId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the restore job to return.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "cancelled": true,
  • "deliveryType": "automated",
  • "deliveryUrl": [
    ],
  • "desiredTimestamp": { },
  • "expired": true,
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "failed": true,
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "id": "e7cb93f480f357b5139ccf37",
  • "snapshotId": "78e18e587716102f711a5bca",
  • "targetClusterName": "string",
  • "targetGroupId": "ca4d8a18b96b317422974eec",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Cloud Backup Schedule

Returns, edits, and removes Cloud Backup schedules.

Remove All Cloud Backup Schedules

Removes all cloud backup schedules for the specified cluster. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "autoExportEnabled": true,
  • "clusterId": "5faec72692cee15b51eb22a4",
  • "clusterName": "string",
  • "export": {
    },
  • "links": [ ],
  • "nextSnapshot": "2019-08-24T14:15:22Z",
  • "policies": [
    ],
  • "referenceHourOfDay": 0,
  • "referenceMinuteOfHour": 0,
  • "restoreWindowDays": 0,
  • "useOrgAndGroupNamesInExportPrefix": true
}

Return One Cloud Backup Schedule

Returns the cloud backup schedule for the specified cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "autoExportEnabled": true,
  • "clusterId": "5faec72692cee15b51eb22a4",
  • "clusterName": "string",
  • "export": {
    },
  • "links": [ ],
  • "nextSnapshot": "2019-08-24T14:15:22Z",
  • "policies": [
    ],
  • "referenceHourOfDay": 0,
  • "referenceMinuteOfHour": 0,
  • "restoreWindowDays": 0,
  • "useOrgAndGroupNamesInExportPrefix": true
}

Update Cloud Backup Schedule for One Cluster

Updates the cloud backup schedule for one cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Updates the cloud backup schedule for one cluster within the specified project.

Note: In the request body, provide only the fields that you want to update.

autoExportEnabled
boolean

Flag that indicates whether MongoDB Cloud automatically exports cloud backup snapshots to the AWS bucket.

object (export)

Policy for automatically exporting cloud backup snapshots.
required
Array of objects (policies) <= 1 items

Rules set for this backup schedule.
referenceHourOfDay
number

Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the snapshot.

referenceMinuteOfHour
number

Minute of the referenceHourOfDay that represents when MongoDB Cloud takes the snapshot.

restoreWindowDays
number

Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous cloud backups only.

updateSnapshots
boolean

Flag that indicates whether to apply the retention changes in the updated backup policy to snapshots that MongoDB Cloud took previously.

useOrgAndGroupNamesInExportPrefix
boolean

Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your AWS bucket.

Responses

Request samples

Content type
application/json
{
  • "autoExportEnabled": true,
  • "export": {
    },
  • "policies": [
    ],
  • "referenceHourOfDay": 0,
  • "referenceMinuteOfHour": 0,
  • "restoreWindowDays": 0,
  • "updateSnapshots": true,
  • "useOrgAndGroupNamesInExportPrefix": true
}

Response samples

Content type
application/json
{
  • "autoExportEnabled": true,
  • "clusterId": "5faec72692cee15b51eb22a4",
  • "clusterName": "string",
  • "export": {
    },
  • "links": [ ],
  • "nextSnapshot": "2019-08-24T14:15:22Z",
  • "policies": [
    ],
  • "referenceHourOfDay": 0,
  • "referenceMinuteOfHour": 0,
  • "restoreWindowDays": 0,
  • "useOrgAndGroupNamesInExportPrefix": true
}

Cloud Migration Service

Manages the Cloud Migration Service.

Migrate One Local Managed Cluster to MongoDB Atlas

Migrate one Cluster that Cloud or Ops Manager manages to MongoDB Atlas.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

One migration to be created.

required
object (Destination)

Document that describes the destination of the migration.
dropEnabled
required
boolean

Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.

migrationHosts
required
Array of strings = 1 items

List of migration hosts used for this migration.
required
object (Source)

Document that describes the source of the migration.

Responses

Request samples

Content type
application/json
{
  • "destination": {
    },
  • "dropEnabled": true,
  • "migrationHosts": [
    ],
  • "source": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "6296fb4c7c7aa997cf94e9a8",
  • "lagTimeSeconds": 0,
  • "migrationHosts": "vm001.example.com",
  • "readyForCutover": true,
  • "status": "NEW"
}

Validate One Migration Request

Check whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. If the check passes, the migration can proceed.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

One migration to be validated.

required
object (Destination)

Document that describes the destination of the migration.
dropEnabled
required
boolean

Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.

migrationHosts
required
Array of strings = 1 items

List of migration hosts used for this migration.
required
object (Source)

Document that describes the source of the migration.

Responses

Request samples

Content type
application/json
{
  • "destination": {
    },
  • "dropEnabled": true,
  • "migrationHosts": [
    ],
  • "source": {
    }
}

Response samples

Content type
application/json
{
  • "_id": { },
  • "errorMessage": "string",
  • "groupId": "ca4d8a18b96b317422974eec",
  • "sourceGroupId": "32b6e34b3d91647abb20e7b8",
  • "status": "PENDING"
}

Return One Migration Validation Job

Return the status of one migration validation job.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

validationId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 507f1f77bcf86cd799439011

Unique 24-hexadecimal digit string that identifies the validation job.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "_id": { },
  • "errorMessage": "string",
  • "groupId": "ca4d8a18b96b317422974eec",
  • "sourceGroupId": "32b6e34b3d91647abb20e7b8",
  • "status": "PENDING"
}

Return One Migration Job

Return details of one cluster migration job.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

liveMigrationId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 6296fb4c7c7aa997cf94e9a8

Unique 24-hexadecimal digit string that identifies the migration.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "_id": "6296fb4c7c7aa997cf94e9a8",
  • "lagTimeSeconds": 0,
  • "migrationHosts": "vm001.example.com",
  • "readyForCutover": true,
  • "status": "NEW"
}

Cut Over the Migrated Cluster

Cut over the migrated cluster to MongoDB Cloud. Confirm when the cut over completes. When the cut over completes, MongoDB Cloud completes the live migration process and stops synchronizing with the source cluster.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

liveMigrationId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 6296fb4c7c7aa997cf94e9a8

Unique 24-hexadecimal digit string that identifies the migration.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "_id": { },
  • "errorMessage": "string",
  • "groupId": "ca4d8a18b96b317422974eec",
  • "sourceGroupId": "32b6e34b3d91647abb20e7b8",
  • "status": "PENDING"
}

Return All Projects Available for Migration

Return all projects that you can migrate to the specified organization.

path Parameters
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create One Link-Token

Create one link-token that contains all the information required to complete the link.

path Parameters
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json
accessListIps
Array of strings

Responses

Request samples

Content type
application/json
{
  • "accessListIps": [
    ]
}

Response samples

Content type
application/json
{
  • "linkToken": "string"
}

Return Status of the Organization Link

Return the status of the organization link specified by the orgId.

path Parameters
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "status": "SYNCED"
}

Cloud Provider Access

Returns, adds, authorizes, and removes AWS IAM roles in Atlas.

Return All Cloud Provider Access Roles

Returns all Amazon Web Services (AWS) Identity and Access Management (IAM) roles with access to the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "awsIamRoles": [
    ]
}

Create One Cloud Provider Access Role

Creates one Amazon Web Services (AWS) Identity and Access Management (IAM) role. Some MongoDB Cloud features use AWS IAM roles for authentication. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

After a successful request to this API endpoint, you can add the atlasAWSAccountArn and atlasAssumedRoleExternalId values to the trust policy in your AWS console to create an IAM Assumed Amazon Resource Name (ARN).

Set Up Unified AWS Access
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Creates one AWS IAM role.

providerName
required
string
Default: "AWS"

Human-readable label that identifies the cloud provider of the role.

iamAssumedRoleArn
string [ 20 .. 2048 ] characters

Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account.

Responses

Request samples

Content type
application/json
{
  • "providerName": "AWS",
  • "iamAssumedRoleArn": "arn:aws:iam::123456789012:root"
}

Response samples

Content type
application/json
{
  • "providerName": "AWS",
  • "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
  • "atlasAssumedRoleExternalId": "24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
  • "authorizedDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "featureUsages": [
    ],
  • "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
  • "roleId": "1ffa0028ed80f089383c05bf"
}

Deauthorize One Cloud Provider Access Role

Revokes access to the specified project for the specified AWS IAM role. To use this resource,the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

cloudProvider
required
string
Value: "AWS"

Human-readable label that identifies the cloud provider of the role to deauthorize.

roleId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the role.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Authorize One Cloud Provider Access Role

Grants access to the specified project for the specified Amazon Web Services (AWS) Identity and Access Management (IAM) role. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

Set Up Unified AWS Access
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

roleId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the role.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Grants access to the specified project for the specified AWS IAM role.

providerName
required
string
Default: "AWS"

Human-readable label that identifies the cloud provider of the role.

iamAssumedRoleArn
string [ 20 .. 2048 ] characters

Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account.

Responses

Request samples

Content type
application/json
{
  • "providerName": "AWS",
  • "iamAssumedRoleArn": "arn:aws:iam::123456789012:root"
}

Response samples

Content type
application/json
{
  • "providerName": "AWS",
  • "atlasAWSAccountArn": "arn:aws:iam::772401394250:role/my-test-aws-role",
  • "atlasAssumedRoleExternalId": "24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
  • "authorizedDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "featureUsages": [
    ],
  • "iamAssumedRoleArn": "arn:aws:iam::123456789012:root",
  • "roleId": "1ffa0028ed80f089383c05bf"
}

Clusters

Returns, adds, edits, and removes database deployments.

Return All Clusters in One Project

Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To return multi-cloud clusters, use Get All Advanced Clusters. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "links": [ ],
  • "results": [
    ],
  • "totalCount": 0
}

Create One Cluster

Creates one cluster in the specific project. Clusters contain a group of hosts that maintain the same data set. This resource does not create multi-cloud clusters. To create a multi-cloud cluster, use Create One Advanced Cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Details to create for one cluster in the specified project.

object (Automatic Cluster Scaling Settings)

Range of instance sizes to which your cluster can scale.

Cluster Auto-Scaling
backupEnabled
boolean

Flag that indicates whether the cluster can perform backups. If set to true, the cluster can perform backups. You must set this value to true for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to false, the cluster doesn't use MongoDB Cloud backups.

object (MongoDB Connector for Business Intelligence Settings)

Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.

MongoDB Connector for Business Intelligence
clusterType
string
Enum: "REPLICASET" "SHARDED" "GEOSHARDED"

Configuration of nodes that comprise the cluster.
diskSizeGB
number [ 10 .. 4096 ]

Storage capacity that the host's root volume possesses expressed in gigabytes. Increase this number to add capacity. MongoDB Cloud requires this parameter if you set replicationSpecs. If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.

encryptionAtRestProvider
string
Enum: "AWS" "AZURE" "GCP" "NONE"

Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.

Encryption at Rest using Customer Key Management
Array of objects (Component Label)

Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.

mongoDBMajorVersion
string
Default: "4.4"
Enum: "3.6" "4.0" "4.2" "4.4" "5.0"

Major MongoDB version of the cluster. MongoDB Cloud deploys the cluster with the latest stable release of the specified version.

name
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
numShards
number [ 1 .. 50 ]
Default: 1

Number of shards up to 50 to deploy for a sharded cluster. The resource returns 1 to indicate a replica set and values of 2 and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.

Sharding
paused
boolean

Flag that indicates whether the cluster is paused.
pitEnabled
boolean

Flag that indicates whether the cluster uses continuous cloud backups.

Continuous Cloud Backups
providerBackupEnabled
boolean

Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to true, the cluster can perform backups. If this and backupEnabled are set to false, the cluster doesn't use MongoDB Cloud backups.

object (Cloud Service Provider Settings)

Group of settings that configure the provisioned MongoDB hosts. The options available relate to the cloud service provider.

replicationFactor
number
Deprecated
Default: 3
Enum: 3 5 7

Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use replicationSpecs instead.

object (Region Configuration)
Deprecated

Physical location where MongoDB Cloud provisions cluster nodes.
Array of objects (Replication Settings)

List of settings that configure your cluster regions.

  • For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.
  • For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.
rootCertType
string
Default: "ISRGROOTX1"
Value: "ISRGROOTX1"

Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.

versionReleaseSystem
string
Default: "LTS"
Enum: "CONTINUOUS" "LTS"

Method by which the cluster maintains the MongoDB versions. If value is CONTINUOUS, you must not specify mongoDBMajorVersion.

Responses

Request samples

Content type
application/json
{
  • "autoScaling": {
    },
  • "backupEnabled": true,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "diskSizeGB": 10,
  • "encryptionAtRestProvider": "AWS",
  • "labels": [
    ],
  • "mongoDBMajorVersion": "3.6",
  • "name": "string",
  • "numShards": 1,
  • "paused": true,
  • "pitEnabled": true,
  • "providerBackupEnabled": true,
  • "providerSettings": {
    },
  • "replicationFactor": 3,
  • "replicationSpec": {
    },
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "versionReleaseSystem": "CONTINUOUS"
}

Response samples

Content type
application/json
{
  • "autoScaling": {
    },
  • "backupEnabled": true,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskSizeGB": 10,
  • "encryptionAtRestProvider": "AWS",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "5faec72692cee15b51eb22a4",
  • "labels": [
    ],
  • "links": [ ],
  • "mongoDBMajorVersion": "3.6",
  • "mongoDBVersion": "string",
  • "mongoURI": "string",
  • "mongoURIUpdated": "2019-08-24T14:15:22Z",
  • "mongoURIWithOptions": "string",
  • "name": "string",
  • "numShards": 1,
  • "paused": true,
  • "pitEnabled": true,
  • "providerBackupEnabled": true,
  • "providerSettings": {
    },
  • "replicationFactor": 3,
  • "replicationSpec": {
    },
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "srvAddress": "string",
  • "stateName": "CREATING",
  • "versionReleaseSystem": "CONTINUOUS"
}

Return All Cloud Provider Regions

Returns the list of regions available for the specified cloud provider at the specified tier. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

providers
string

Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters.

tier
string

Cluster tier for which to retrieve the regions.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Upgrade One Shared-tier Cluster

Upgrade a shared-tier cluster in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. This resource doesn't require the API key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Details of the tenant upgrade in the specified project.

object (Automatic Cluster Scaling Settings)

Range of instance sizes to which your cluster can scale.

Cluster Auto-Scaling
backupEnabled
boolean

Flag that indicates whether the cluster can perform backups. If set to true, the cluster can perform backups. You must set this value to true for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to false, the cluster doesn't use MongoDB Cloud backups.

object (MongoDB Connector for Business Intelligence Settings)

Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.

MongoDB Connector for Business Intelligence
clusterType
string
Enum: "REPLICASET" "SHARDED" "GEOSHARDED"

Configuration of nodes that comprise the cluster.
diskSizeGB
number [ 10 .. 4096 ]

Storage capacity that the host's root volume possesses expressed in gigabytes. Increase this number to add capacity. MongoDB Cloud requires this parameter if you set replicationSpecs. If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.

encryptionAtRestProvider
string
Enum: "AWS" "AZURE" "GCP" "NONE"

Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.

Encryption at Rest using Customer Key Management
Array of objects (Component Label)

Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.

mongoDBMajorVersion
string
Default: "4.4"
Enum: "3.6" "4.0" "4.2" "4.4" "5.0"

Major MongoDB version of the cluster. MongoDB Cloud deploys the cluster with the latest stable release of the specified version.

name
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
numShards
number [ 1 .. 50 ]
Default: 1

Number of shards up to 50 to deploy for a sharded cluster. The resource returns 1 to indicate a replica set and values of 2 and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.

Sharding
paused
boolean

Flag that indicates whether the cluster is paused.
pitEnabled
boolean

Flag that indicates whether the cluster uses continuous cloud backups.

Continuous Cloud Backups
providerBackupEnabled
boolean

Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to true, the cluster can perform backups. If this and backupEnabled are set to false, the cluster doesn't use MongoDB Cloud backups.

object (Cloud Service Provider Settings)

Group of settings that configure the provisioned MongoDB hosts. The options available relate to the cloud service provider.

replicationFactor
number
Deprecated
Default: 3
Enum: 3 5 7

Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use replicationSpecs instead.

object (Region Configuration)
Deprecated

Physical location where MongoDB Cloud provisions cluster nodes.
Array of objects (Replication Settings)

List of settings that configure your cluster regions.

  • For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.
  • For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.
rootCertType
string
Default: "ISRGROOTX1"
Value: "ISRGROOTX1"

Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.

versionReleaseSystem
string
Default: "LTS"
Enum: "CONTINUOUS" "LTS"

Method by which the cluster maintains the MongoDB versions. If value is CONTINUOUS, you must not specify mongoDBMajorVersion.

Responses

Request samples

Content type
application/json
{
  • "autoScaling": {
    },
  • "backupEnabled": true,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "diskSizeGB": 10,
  • "encryptionAtRestProvider": "AWS",
  • "labels": [
    ],
  • "mongoDBMajorVersion": "3.6",
  • "name": "string",
  • "numShards": 1,
  • "paused": true,
  • "pitEnabled": true,
  • "providerBackupEnabled": true,
  • "providerSettings": {
    },
  • "replicationFactor": 3,
  • "replicationSpec": {
    },
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "versionReleaseSystem": "CONTINUOUS"
}

Response samples

Content type
application/json
{
  • "autoScaling": {
    },
  • "backupEnabled": true,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskSizeGB": 10,
  • "encryptionAtRestProvider": "AWS",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "5faec72692cee15b51eb22a4",
  • "labels": [
    ],
  • "links": [ ],
  • "mongoDBMajorVersion": "3.6",
  • "mongoDBVersion": "string",
  • "mongoURI": "string",
  • "mongoURIUpdated": "2019-08-24T14:15:22Z",
  • "mongoURIWithOptions": "string",
  • "name": "string",
  • "numShards": 1,
  • "paused": true,
  • "pitEnabled": true,
  • "providerBackupEnabled": true,
  • "providerSettings": {
    },
  • "replicationFactor": 3,
  • "replicationSpec": {
    },
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "srvAddress": "string",
  • "stateName": "CREATING",
  • "versionReleaseSystem": "CONTINUOUS"
}

Return One Advanced Configuration Options for One Cluster

Returns the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings.

Shared-tier clusters can't use this resource.

To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

Global Clusters
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "defaultReadConcern": "local",
  • "defaultWriteConcern": "1",
  • "failIndexKeyTooLong": true,
  • "javascriptEnabled": true,
  • "minimumEnabledTlsProtocol": "TLS1_0",
  • "noTableScan": false,
  • "oplogMinRetentionHours": 0,
  • "oplogSizeMB": 0,
  • "sampleRefreshIntervalBIConnector": 0,
  • "sampleSizeBIConnector": 1000
}

Update Advanced Configuration Options for One Cluster

Updates the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting API Key must have the Project Cluster Manager role. This resource doesn't require the API Key to have an Access List.

Global Clusters
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Advanced configuration details to add for one cluster in the specified project.

defaultReadConcern
string
Default: "available"
Enum: "local" "available" "majority" "linearizable" "snapshot"

Default level of acknowledgment requested from MongoDB for read operations set for this cluster.

MongoDB 4.4 clusters default to available. MongoDB 5.0 and later clusters default to local.

defaultWriteConcern
string
Default: "1"

Default level of acknowledgment requested from MongoDB for write operations set for this cluster.

MongoDB 4.4 clusters default to 1. MongoDB 5.0 and later clusters default to majority.

failIndexKeyTooLong
boolean
Default: true

Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes. If you set this to false, mongod writes documents that exceed this limit but doesn't index them.

This option corresponds to the `failIndexKeyTooLong` `mongod` configuration file option.
javascriptEnabled
minimumEnabledTlsProtocol
string
Enum: "TLS1_0" "TLS1_1" "TLS1_2"

Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.

This option corresponds to the `net.ssl.disabledProtocols` `mongod` configuration file option.
noTableScan
boolean
Default: false

Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results.

This option corresponds to the `notablescan` `mongod` configuration file option.
oplogMinRetentionHours
number or null <double>

Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates.

This option corresponds to the `storage.oplogMinRetentionHours` `mongod` configuration file option.
oplogSizeMB
integer or null <int32>

Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates.

This option corresponds to the `replication.oplogSizeMB` `mongod` configuration file option.
sampleRefreshIntervalBIConnector
integer <int32> >= 0
Default: 0

Interval in seconds at which the mongosqld process re-samples data to create its relational schema.

This option corresponds to the `sampleRefreshIntervalSecs` `mongosqld` option.
sampleSizeBIConnector
integer <int32> >= 0
Default: 1000

Number of documents per database to sample when gathering schema information.

This option corresponds to the `sampleSize` `mongosqld` option.

Responses

Request samples

Content type
application/json
{
  • "defaultReadConcern": "local",
  • "defaultWriteConcern": "1",
  • "failIndexKeyTooLong": true,
  • "javascriptEnabled": true,
  • "minimumEnabledTlsProtocol": "TLS1_0",
  • "noTableScan": false,
  • "oplogMinRetentionHours": 0,
  • "oplogSizeMB": 0,
  • "sampleRefreshIntervalBIConnector": 0,
  • "sampleSizeBIConnector": 1000
}

Response samples

Content type
application/json
{
  • "defaultReadConcern": "local",
  • "defaultWriteConcern": "1",
  • "failIndexKeyTooLong": true,
  • "javascriptEnabled": true,
  • "minimumEnabledTlsProtocol": "TLS1_0",
  • "noTableScan": false,
  • "oplogMinRetentionHours": 0,
  • "oplogSizeMB": 0,
  • "sampleRefreshIntervalBIConnector": 0,
  • "sampleSizeBIConnector": 1000
}

Test Failover for One Cluster

Starts a failover test for the specified cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster's primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. To use this resource, the requesting API Key must have the Project Cluster Manager role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "parameters": [
    ],
  • "reason": "Unauthorized"
}

Return Status of All Cluster Operations

Returns the status of all changes that you made to the specified cluster in the specified project. Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Remove One Cluster

Removes one cluster in the specific project. Clusters contain a group of hosts that maintain the same data set. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

Global Clusters
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

name
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Cluster in One Project

Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To return a multi-cloud cluster, use Get One Advanced Cluster. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

name
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "autoScaling": {
    },
  • "backupEnabled": true,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskSizeGB": 10,
  • "encryptionAtRestProvider": "AWS",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "5faec72692cee15b51eb22a4",
  • "labels": [
    ],
  • "links": [ ],
  • "mongoDBMajorVersion": "3.6",
  • "mongoDBVersion": "string",
  • "mongoURI": "string",
  • "mongoURIUpdated": "2019-08-24T14:15:22Z",
  • "mongoURIWithOptions": "string",
  • "name": "string",
  • "numShards": 1,
  • "paused": true,
  • "pitEnabled": true,
  • "providerBackupEnabled": true,
  • "providerSettings": {
    },
  • "replicationFactor": 3,
  • "replicationSpec": {
    },
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "srvAddress": "string",
  • "stateName": "CREATING",
  • "versionReleaseSystem": "CONTINUOUS"
}

Update Configuration of One Cluster

Update the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource does not update multi-cloud clusters. To update a multi-cloud cluster, use Update One Advanced Cluster. To use this resource, the requesting API Key must have the Project Cluster Manager role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

name
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Details to update for one cluster in the specified project.

object (Automatic Cluster Scaling Settings)

Range of instance sizes to which your cluster can scale.

Cluster Auto-Scaling
backupEnabled
boolean

Flag that indicates whether the cluster can perform backups. If set to true, the cluster can perform backups. You must set this value to true for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to false, the cluster doesn't use MongoDB Cloud backups.

object (MongoDB Connector for Business Intelligence Settings)

Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.

MongoDB Connector for Business Intelligence
clusterType
string
Enum: "REPLICASET" "SHARDED" "GEOSHARDED"

Configuration of nodes that comprise the cluster.
diskSizeGB
number [ 10 .. 4096 ]

Storage capacity that the host's root volume possesses expressed in gigabytes. Increase this number to add capacity. MongoDB Cloud requires this parameter if you set replicationSpecs. If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.

encryptionAtRestProvider
string
Enum: "AWS" "AZURE" "GCP" "NONE"

Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.

Encryption at Rest using Customer Key Management
Array of objects (Component Label)

Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.

mongoDBMajorVersion
string
Default: "4.4"
Enum: "3.6" "4.0" "4.2" "4.4" "5.0"

Major MongoDB version of the cluster. MongoDB Cloud deploys the cluster with the latest stable release of the specified version.

name
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
numShards
number [ 1 .. 50 ]
Default: 1

Number of shards up to 50 to deploy for a sharded cluster. The resource returns 1 to indicate a replica set and values of 2 and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.

Sharding
paused
boolean

Flag that indicates whether the cluster is paused.
pitEnabled
boolean

Flag that indicates whether the cluster uses continuous cloud backups.

Continuous Cloud Backups
providerBackupEnabled
boolean

Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to true, the cluster can perform backups. If this and backupEnabled are set to false, the cluster doesn't use MongoDB Cloud backups.

object (Cloud Service Provider Settings)

Group of settings that configure the provisioned MongoDB hosts. The options available relate to the cloud service provider.

replicationFactor
number
Deprecated
Default: 3
Enum: 3 5 7

Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use replicationSpecs instead.

object (Region Configuration)
Deprecated

Physical location where MongoDB Cloud provisions cluster nodes.
Array of objects (Replication Settings)

List of settings that configure your cluster regions.

  • For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.
  • For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.
rootCertType
string
Default: "ISRGROOTX1"
Value: "ISRGROOTX1"

Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.

versionReleaseSystem
string
Default: "LTS"
Enum: "CONTINUOUS" "LTS"

Method by which the cluster maintains the MongoDB versions. If value is CONTINUOUS, you must not specify mongoDBMajorVersion.

Responses

Request samples

Content type
application/json
{
  • "autoScaling": {
    },
  • "backupEnabled": true,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "diskSizeGB": 10,
  • "encryptionAtRestProvider": "AWS",
  • "labels": [
    ],
  • "mongoDBMajorVersion": "3.6",
  • "name": "string",
  • "numShards": 1,
  • "paused": true,
  • "pitEnabled": true,
  • "providerBackupEnabled": true,
  • "providerSettings": {
    },
  • "replicationFactor": 3,
  • "replicationSpec": {
    },
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "versionReleaseSystem": "CONTINUOUS"
}

Response samples

Content type
application/json
{
  • "autoScaling": {
    },
  • "backupEnabled": true,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskSizeGB": 10,
  • "encryptionAtRestProvider": "AWS",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "5faec72692cee15b51eb22a4",
  • "labels": [
    ],
  • "links": [ ],
  • "mongoDBMajorVersion": "3.6",
  • "mongoDBVersion": "string",
  • "mongoURI": "string",
  • "mongoURIUpdated": "2019-08-24T14:15:22Z",
  • "mongoURIWithOptions": "string",
  • "name": "string",
  • "numShards": 1,
  • "paused": true,
  • "pitEnabled": true,
  • "providerBackupEnabled": true,
  • "providerSettings": {
    },
  • "replicationFactor": 3,
  • "replicationSpec": {
    },
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "srvAddress": "string",
  • "stateName": "CREATING",
  • "versionReleaseSystem": "CONTINUOUS"
}

Load Sample Dataset Request into Cluster

Requests loading the MongoDB sample dataset into the specified cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

name
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster into which you load the sample dataset.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Request Body schema: application/json

Cluster into which to load the sample dataset.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

Check Status of Cluster Sample Dataset Request

Checks the progress of loading the sample dataset into one cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

sampleDatasetId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the loaded sample dataset.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "_id": "4c0971b71b6b7c6e2020b535",
  • "clusterName": "string",
  • "completeDate": "string",
  • "createDate": "string",
  • "errorMessage": "string",
  • "state": "COMPLETED"
}

Return All Authorized Clusters in All Projects

Returns the details for all clusters in all projects to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting API Key can have any cluster-level role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Custom DNS for Atlas Clusters Deployed to AWS

Returns and edits custom DNS configurations for Atlas database deployments on AWS.

Return One Custom DNS Configuration for Atlas Clusters on AWS

Returns the custom DNS configuration for AWS clusters in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "enabled": true
}

Toggle State of One Custom DNS Configuration for Atlas Clusters on AWS

Enables or disables the custom DNS configuration for AWS clusters in the specified project. Enable custom DNS if you use AWS VPC peering and use your own DNS servers. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Enables or disables the custom DNS configuration for AWS clusters in the specified project.

enabled
required
boolean

Flag that indicates whether the project's clusters deployed to Amazon Web Services (AWS) use a custom Domain Name System (DNS). When "enabled": true, connect to your cluster using Private IP for Peering connection strings.

To learn more, see FAQ: Connection String Options in the MongoDB Atlas documentation.

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "enabled": true
}

Custom Database Roles

Returns, adds, edits, and removes custom database user privilege roles.

Return All Custom Roles in One Project

Returns all custom roles for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create One Custom Role

Creates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Creates one custom role in the specified project.

Array of objects (Database Privilege Action)

List of the individual privilege actions that the role grants.
Array of objects (Inherited Role) unique

List of the built-in roles that this custom role inherits.
roleName
required
string^\b(?!xgen-)([0-9A-Za-z_\-]+)\b(?<!\atlasAdmi...

Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.

Responses

Request samples

Content type
application/json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

Remove One Custom Role from One Project

Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

roleName
required
string^\b(?!xgen-)([0-9A-Za-z_\-]+)\b(?<!\atlasAdmi...

Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Custom Role in One Project

Returns one custom role for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

roleName
required
string^\b(?!xgen-)([0-9A-Za-z_\-]+)\b(?<!\atlasAdmi...

Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

Update One Custom Role in One Project

Updates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

roleName
required
string^\b(?!xgen-)([0-9A-Za-z_\-]+)\b(?<!\atlasAdmi...

Human-readable label that identifies the role for the request. This name must beunique for this custom role in this project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Updates one custom role in the specified project.

Array of objects (Database Privilege Action)

List of the individual privilege actions that the role grants.
Array of objects (Inherited Role) unique

List of the built-in roles that this custom role inherits.
roleName
required
string^\b(?!xgen-)([0-9A-Za-z_\-]+)\b(?<!\atlasAdmi...

Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project.

Responses

Request samples

Content type
application/json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

Response samples

Content type
application/json
{
  • "actions": [
    ],
  • "inheritedRoles": [
    ],
  • "roleName": "string"
}

Database Users

Returns, adds, edits, and removes database users.

Return All Database Users from One Project

Returns all database users that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Create One Database User in One Project

Creates one database user in the specified project. This MongoDB Cloud supports a maximum of 100 database users per project. If you require more than 100 database users on a project, contact Support. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Creates one database user in the specified project.

One of
databaseName
required
string
Default: "admin"
Enum: "admin" "$external"

MongoDB database against which the MongoDB database user authenticates. MongoDB database users must provide both a username and authentication database to log into MongoDB.

deleteAfterDate
string <date-time> ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Date and time when MongoDB Cloud deletes the user. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. You must specify a future date that falls within one week of making the Application Programming Interface (API) request.

groupId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the project.

Array of objects (Component Label)

List that contains the key-value pairs for tagging and categorizing the MongoDB database user. The labels that you define do not appear in the console.

required
Array of objects (Database User Role)

List that provides the pairings of one role with one applicable database.

Array of objects (Database User Scope)

List that contains clusters and MongoDB Atlas Data Lakes that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters and MongoDB Atlas Data Lakes in the project.

password
required
string >= 8 characters

Alphanumeric string that authenticates this database user against the database specified in databaseName. To authenticate with SCRAM-SHA, you must specify this parameter.

SCRAM-SHA
username
required
string <= 1024 characters

Human-readable label that represents the user that authenticates to MongoDB. This must be formatted as a RFC 2253 Distinguished Name.

Responses

Request samples

Content type
application/json
Example
{
  • "databaseName": "admin",
  • "deleteAfterDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "labels": [
    ],
  • "roles": [
    ],
  • "scopes": [
    ],
  • "password": "stringst",
  • "username": "UID=pat.bloggs@example.com,CN=Pat Bloggs,OU=engineering,DC=example,DC=com"
}

Response samples

Content type
application/json
Example
{ }

Remove One Database User from One Project

Removes one database user from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

databaseName
required
string

Human-readable label that identifies the database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, or LDAP, this value should be $external. If the user authenticates with SCRAM-SHA, this value should be admin.

username
required
string
Example: SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs orx.509 or LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM

Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:

Authentication Method Parameter Needed Parameter Value username Format
AWS IAM awsType ROLE ARN
AWS IAM awsType USER ARN
x.509 x509Type CUSTOMER RFC 2253 Distinguished Name
x.509 x509Type MANAGED RFC 2253 Distinguished Name
LDAP ldapAuthType USER RFC 2253 Distinguished Name
LDAP ldapAuthType GROUP RFC 2253 Distinguished Name
SCRAM-SHA awsType, x509Type, ldapAuthType NONE Alphanumeric string
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "parameters": [
    ],
  • "reason": "Unauthorized"
}

Return One Database User from One Project

Returns one database user that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

databaseName
required
string

Human-readable label that identifies the database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, or LDAP, this value should be $external. If the user authenticates with SCRAM-SHA, this value should be admin.

username
required
string
Example: SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs orx.509 or LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM

Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:

Authentication Method Parameter Needed Parameter Value username Format
AWS IAM awsType ROLE ARN
AWS IAM awsType USER ARN
x.509 x509Type CUSTOMER RFC 2253 Distinguished Name
x.509 x509Type MANAGED RFC 2253 Distinguished Name
LDAP ldapAuthType USER RFC 2253 Distinguished Name
LDAP ldapAuthType GROUP RFC 2253 Distinguished Name
SCRAM-SHA awsType, x509Type, ldapAuthType NONE Alphanumeric string
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
Example
{ }

Update One Database User in One Project

Updates one database user that belongs to the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

databaseName
required
string

Human-readable label that identifies the database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. If the user authenticates with AWS IAM, x.509, or LDAP, this value should be $external. If the user authenticates with SCRAM-SHA, this value should be admin.

username
required
string
Example: SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs orx.509 or LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM

Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:

Authentication Method Parameter Needed Parameter Value username Format
AWS IAM awsType ROLE ARN
AWS IAM awsType USER ARN
x.509 x509Type CUSTOMER RFC 2253 Distinguished Name
x.509 x509Type MANAGED RFC 2253 Distinguished Name
LDAP ldapAuthType USER RFC 2253 Distinguished Name
LDAP ldapAuthType GROUP RFC 2253 Distinguished Name
SCRAM-SHA awsType, x509Type, ldapAuthType NONE Alphanumeric string
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Updates one database user that belongs to the specified project.

One of
databaseName
required
string
Default: "admin"
Enum: "admin" "$external"

MongoDB database against which the MongoDB database user authenticates. MongoDB database users must provide both a username and authentication database to log into MongoDB.

deleteAfterDate
string <date-time> ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Date and time when MongoDB Cloud deletes the user. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. You must specify a future date that falls within one week of making the Application Programming Interface (API) request.

groupId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the project.

Array of objects (Component Label)

List that contains the key-value pairs for tagging and categorizing the MongoDB database user. The labels that you define do not appear in the console.

required
Array of objects (Database User Role)

List that provides the pairings of one role with one applicable database.

Array of objects (Database User Scope)

List that contains clusters and MongoDB Atlas Data Lakes that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters and MongoDB Atlas Data Lakes in the project.

password
required
string >= 8 characters

Alphanumeric string that authenticates this database user against the database specified in databaseName. To authenticate with SCRAM-SHA, you must specify this parameter.

SCRAM-SHA
username
required
string <= 1024 characters

Human-readable label that represents the user that authenticates to MongoDB. This must be formatted as a RFC 2253 Distinguished Name.

Responses

Request samples

Content type
application/json
Example
{
  • "databaseName": "admin",
  • "deleteAfterDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "labels": [
    ],
  • "roles": [
    ],
  • "scopes": [
    ],
  • "password": "stringst",
  • "username": "UID=pat.bloggs@example.com,CN=Pat Bloggs,OU=engineering,DC=example,DC=com"
}

Response samples

Content type
application/json
Example
{ }

Data Federation

Returns, adds, edits, and removes Federated Database Instances.

Return All Federated Databases in One Project

Returns the details of all Federated Databases in the specified project. To use this resource, the requesting API Key must have the Project Read Only or higher role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create One Federated Database in One Project

Creates one Federated Database in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Details to create one Federated Database in the specified project.

object (Data Lake Cloud Provider)

Cloud provider linked to this data lake.

Responses

Request samples

Content type
application/json
{
  • "cloudProviderConfig": {
    }
}

Response samples

Content type
application/json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "name": "string",
  • "storage": {
    }
}

Remove One Federated Database from One Project

Removes one Federated Database from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

tenantName
required
string

Human-readable label that identifies the Federated Database to remove.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  • "error": 404,
  • "errorCode": "RESOURCE_NOT_FOUND",
  • "parameters": [
    ],
  • "reason": "Not Found"
}

Return One Federated Database in One Project

Returns the details of one Federated Database within the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

tenantName
required
string

Human-readable label that identifies the Federated Database to return.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "name": "string",
  • "storage": {
    }
}

Update One Federated Database in One Project

Updates the details of one Federated Database in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin or higher role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

tenantName
required
string

Human-readable label that identifies the Federated Database to update.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

skipRoleValidation
required
boolean

Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check.

Request Body schema: application/json

Details of one Federated Database to update in the specified project.

object (Data Lake Cloud Provider)

Cloud provider linked to this data lake.

Responses

Request samples

Content type
application/json
{
  • "cloudProviderConfig": {
    }
}

Response samples

Content type
application/json
{
  • "cloudProviderConfig": {
    },
  • "dataProcessRegion": {
    },
  • "name": "string",
  • "storage": {
    }
}

Download Query Logs for One Federated Database

Downloads the query logs for the specified Federated Database. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Data Access Read Write roles. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

tenantName
required
string

Human-readable label that identifies the Federated Database for which you want to download query logs.

query Parameters
endDate
number1199145600
Example: endDate=1636481348

Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.

startDate
number1199145600
Example: startDate=1636466948

Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Data Federation Private Networks

Returns, adds, and removes all private endpoints for Federated Database Instances and Online Archives in the specified project.

Return All Federated Database Instance and Online Archive Private Endpoints in One Project

Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create One Federated Database Instance and Online Archive Private Endpoint for One Project

Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Private endpoint for Federated Database Instances and Online Archives to add to the specified project.

comment
string

Human-readable string to associate with this private endpoint.
endpointId
required
string = 22 characters ^vpce-[0-9a-f]{17}$

Unique 22-character alphanumeric string that identifies the private endpoint.

Atlas Data Lake supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
provider
string
Default: "AWS"
Value: "AWS"

Human-readable label that identifies the cloud service provider. Atlas Data Lake supports Amazon Web Services only.

type
string
Default: "DATA_LAKE"
Value: "DATA_LAKE"

Human-readable label that identifies the resource type associated with this private endpoint.

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "endpointId": "vpce-3bf78b0ddee411ba1",
  • "provider": "AWS",
  • "type": "DATA_LAKE"
}

Response samples

Content type
application/json
[
  • {
    }
]

Remove One Federated Database Instance and Online Archive Private Endpoint from One Project

Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

endpointId
required
string = 22 characters ^vpce-[0-9a-f]{17}$

Unique 22-character alphanumeric string that identifies the private endpoint to remove. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "parameters": [
    ],
  • "reason": "Unauthorized"
}

Return One Federated Database Instance and Online Archive Private Endpoint in One Project

Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

endpointId
required
string = 22 characters ^vpce-[0-9a-f]{17}$

Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "comment": "string",
  • "endpointId": "vpce-3bf78b0ddee411ba1",
  • "provider": "AWS",
  • "type": "DATA_LAKE"
}

Data Lake Pipelines

Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.

Return All Data Lake Pipelines from One Project

Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create One Data Lake Pipeline

Creates one Data Lake Pipeline.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Request Body schema: application/json

Creates one Data Lake Pipeline.

name
string

Name of this Data Lake Pipeline.
object (Ingestion Destination)

Ingestion destination of a Data Lake Pipeline.
object (Ingestion Source)

Ingestion Source of a Data Lake Pipeline.
Array of objects (Field Transformation)

Fields to be excluded for this Data Lake Pipeline.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "transformations": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "887821d389de9fe084df2bdf",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

Remove One Data Lake Pipeline

Removes one Data Lake Pipeline.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

pipelineName
required
string [ 1 .. 64 ] characters ^[^/\\ "$]{1,64}$

Human-readable label that identifies the Data Lake Pipeline.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "parameters": [
    ],
  • "reason": "Unauthorized"
}

Return One Data Lake Pipeline

Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

pipelineName
required
string [ 1 .. 64 ] characters ^[^/\\ "$]{1,64}$

Human-readable label that identifies the Data Lake Pipeline.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "_id": "887821d389de9fe084df2bdf",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

Update One Data Lake Pipeline

Updates one Data Lake Pipeline.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

pipelineName
required
string [ 1 .. 64 ] characters ^[^/\\ "$]{1,64}$

Human-readable label that identifies the Data Lake Pipeline.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Request Body schema: application/json

Updates one Data Lake Pipeline.

name
string

Name of this Data Lake Pipeline.
object (Ingestion Destination)

Ingestion destination of a Data Lake Pipeline.
object (Ingestion Source)

Ingestion Source of a Data Lake Pipeline.
Array of objects (Field Transformation)

Fields to be excluded for this Data Lake Pipeline.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "transformations": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "887821d389de9fe084df2bdf",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

Return Available Ingestion Schedules for One Data Lake Pipeline

Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting API Key must have the Project Read Only role.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

pipelineName
required
string [ 1 .. 64 ] characters ^[^/\\ "$]{1,64}$

Human-readable label that identifies the Data Lake Pipeline.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return Available Backup Snapshots for One Data Lake Pipeline

Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting API Key must have the Project Read Only role.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

pipelineName
required
string [ 1 .. 64 ] characters ^[^/\\ "$]{1,64}$

Human-readable label that identifies the Data Lake Pipeline.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

completedAfter
string <date-time> ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...
Example: completedAfter=2022-01-01T00:00:00.000Z

Date and time after which MongoDB Cloud created the snapshot. If specified, MongoDB Cloud returns available backup snapshots created after this time and date only. This parameter expresses its value in the ISO 8601 timestamp format in UTC.

Responses

Response samples

Content type
application/json
{ }

Pause One Data Lake Pipeline

Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

pipelineName
required
string [ 1 .. 64 ] characters ^[^/\\ "$]{1,64}$

Human-readable label that identifies the Data Lake Pipeline.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "_id": "887821d389de9fe084df2bdf",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

Resume One Data Lake Pipeline

Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

pipelineName
required
string [ 1 .. 64 ] characters ^[^/\\ "$]{1,64}$

Human-readable label that identifies the Data Lake Pipeline.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "_id": "887821d389de9fe084df2bdf",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "sink": {
    },
  • "source": {
    },
  • "state": "ACTIVE",
  • "transformations": [
    ]
}

Return All Data Lake Pipeline Runs from One Project

Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

pipelineName
required
string [ 1 .. 64 ] characters ^[^/\\ "$]{1,64}$

Human-readable label that identifies the Data Lake Pipeline.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

createdBefore
string <date-time> ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...
Example: createdBefore=2022-01-01T00:00:00.000Z

If specified, Atlas returns only Data Lake Pipeline runs initiated before this time and date.

Responses

Response samples

Content type
application/json
{ }

Delete Pipeline Run Dataset

Deletes dataset that Atlas generated during the specified pipeline run.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

pipelineName
required
string [ 1 .. 64 ] characters ^[^/\\ "$]{1,64}$

Human-readable label that identifies the Data Lake Pipeline.
pipelineRunId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 6300603d5fce7d9fd1543170

Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Data Lake Pipeline Run

Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

pipelineName
required
string [ 1 .. 64 ] characters ^[^/\\ "$]{1,64}$

Human-readable label that identifies the Data Lake Pipeline.
pipelineRunId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 6300603d5fce7d9fd1543170

Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "_id": "6300603d5fce7d9fd1543170",
  • "backupFrequencyType": "HOURLY",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "phase": "SNAPSHOT",
  • "pipelineId": "887821d389de9fe084df2bdf",
  • "snapshotId": "78e18e587716102f711a5bca",
  • "state": "EXPORT",
  • "stats": {
    }
}

Trigger on demand snapshot ingestion

Triggers a Data Lake Pipeline ingestion of a specified snapshot.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

pipelineName
required
string [ 1 .. 64 ] characters ^[^/\\ "$]{1,64}$

Human-readable label that identifies the Data Lake Pipeline.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Triggers a single ingestion run of a snapshot.

snapshotId
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal character string that identifies the snapshot.

Responses

Request samples

Content type
application/json
{
  • "snapshotId": "78e18e587716102f711a5bca"
}

Response samples

Content type
application/json
{
  • "_id": "6300603d5fce7d9fd1543170",
  • "backupFrequencyType": "HOURLY",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "lastUpdatedDate": "2019-08-24T14:15:22Z",
  • "phase": "SNAPSHOT",
  • "pipelineId": "887821d389de9fe084df2bdf",
  • "snapshotId": "78e18e587716102f711a5bca",
  • "state": "EXPORT",
  • "stats": {
    }
}

Encryption at Rest using Customer Key Management

Returns and edits the Encryption at Rest using Customer Key Management configuration.

Return One Configuration for Encryption at Rest using Customer-Managed Keys for One Project

Returns the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Atlas Admin role.

LIMITED TO M10 OR GREATER: MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "awsKms": {
    },
  • "azureKeyVault": { },
  • "googleCloudKms": {
    }
}

Update Configuration for Encryption at Rest using Customer-Managed Keys for One Project

Updates the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Atlas Admin role.

LIMITED TO M10 OR GREATER: MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Required parameters depend on whether someone has enabled Encryption at Rest using Customer Key Management:

If you have enabled Encryption at Rest using Customer Key Management (CMK), Atlas requires all of the parameters for the desired encryption provider.

  • To use AWS Key Management Service (KMS), MongoDB Cloud requires all the fields in the awsKms object.
  • To use Azure Key Vault, MongoDB Cloud requires all the fields in the azureKeyVault object.
  • To use Google Cloud Key Management Service (KMS), MongoDB Cloud requires all the fields in the googleCloudKms object.

If you enabled Encryption at Rest using Customer Key Management, administrators can pass only the changed fields for the awsKms, azureKeyVault, or googleCloudKms object to update the configuration to this endpoint.

object (awsKms)

Amazon Web Services (AWS) KMS configuration details and encryption at rest configuration set for the specified project.

Amazon Web Services Key Management Service
object (azureKeyVault)

Details that define the configuration of Encryption at Rest using Azure Key Vault (AKV).

Azure Key Vault
object (googleCloudKms)

Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).

Google Cloud Key Management Service

Responses

Request samples

Content type
application/json
{
  • "awsKms": {
    },
  • "azureKeyVault": { },
  • "googleCloudKms": {
    }
}

Response samples

Content type
application/json
{
  • "awsKms": {
    },
  • "azureKeyVault": { },
  • "googleCloudKms": {
    }
}

Events

Returns events. This collection remains under revision and may change. Refer to the legacy documentation for this collection in the following link.

Events API Legacy Documentation

Return All Events from One Project

Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

This resource remains under revision and may change. Refer to the legacy documentation for this resource.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

clusterNames
Array of strings[ items [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{... ]

Human-readable label that identifies the cluster.
eventType
string
Enum: "AWS_ENCRYPTION_KEY_NEEDS_ROTATION" "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION" "CLUSTER_MONGOS_IS_MISSING" "CPS_RESTORE_FAILED" "CPS_RESTORE_SUCCESSFUL" "CPS_SNAPSHOT_BEHIND" "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED" "CPS_SNAPSHOT_FALLBACK_FAILED" "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL" "CPS_SNAPSHOT_SUCCESSFUL" "CREDIT_CARD_ABOUT_TO_EXPIRE" "DAILY_BILL_OVER_THRESHOLD" "GCP_ENCRYPTION_KEY_NEEDS_ROTATION" "HOST_DOWN" "HOST_MONGOT_CRASHING_OOM" "JOINED_GROUP" "MONGOT_NOT_CRASHING_OOM" "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK" "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" "NO_PRIMARY" "OUTSIDE_METRIC_THRESHOLD" "PENDING_INVOICE_OVER_THRESHOLD" "PRIMARY_ELECTED" "REMOVED_FROM_GROUP" "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" "TOO_MANY_ELECTIONS" "USERS_WITHOUT_MULTI_FACTOR_AUTH" "USER_ROLES_CHANGED_AUDIT"

Category of incident recorded at this moment in time.
includeRaw
boolean
Default: false

Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.

maxDate
string <date-time> ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.

minDate
string <date-time> ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.

Responses

Response samples

Content type
application/json
{
  • "links": [ ],
  • "results": [
    ],
  • "totalCount": 0
}

Return One Event from One Project

Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

This resource remains under revision and may change. Refer to the legacy documentation for this resource.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

eventId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the event that you want to return.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

includeRaw
boolean
Default: false

Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.

Responses

Response samples

Content type
application/json
{
  • "alertConfigId": "adddde5af4ee4bd0b519375f",
  • "alertId": "d268e3a6e1718c6c36376f73",
  • "apiKeyId": "69f24ec71f746985759551c7",
  • "collection": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "currentValue": {
    },
  • "database": "string",
  • "endpointId": "05fcbefce5dd1c8ee5ebf7bf",
  • "eventTypeName": "AWS_ENCRYPTION_KEY_NEEDS_ROTATION",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "375db9d4f7a4c3e01714d02a",
  • "invoiceId": "217a865625b2bad3b9a1e93d",
  • "isGlobalAdmin": false,
  • "links": [ ],
  • "metricName": "ASSERT_REGULAR",
  • "opType": "string",
  • "orgId": "4888442a3354817a7320eb61",
  • "paymentId": "6fb669797183aa180bc5c09a",
  • "port": 0,
  • "providerEndpointId": "string",
  • "publicKey": "stringst",
  • "raw": "string",
  • "remoteAddress": "string",
  • "replicaSetName": "string",
  • "shardName": "string",
  • "targetPublicKey": "string",
  • "targetUsername": "user@example.com",
  • "teamId": "e254e4ade2206f4520d4107d",
  • "userId": "887821d389de9fe084df2bdf",
  • "username": "user@example.com",
  • "whitelistEntry": "string"
}

Return All Events from One Organization

Returns all events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.

This resource remains under revision and may change. Refer to the legacy documentation for this resource.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

eventType
string
Enum: "AWS_ENCRYPTION_KEY_NEEDS_ROTATION" "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION" "CLUSTER_MONGOS_IS_MISSING" "CPS_RESTORE_FAILED" "CPS_RESTORE_SUCCESSFUL" "CPS_SNAPSHOT_BEHIND" "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED" "CPS_SNAPSHOT_FALLBACK_FAILED" "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL" "CPS_SNAPSHOT_SUCCESSFUL" "CREDIT_CARD_ABOUT_TO_EXPIRE" "DAILY_BILL_OVER_THRESHOLD" "GCP_ENCRYPTION_KEY_NEEDS_ROTATION" "HOST_DOWN" "HOST_MONGOT_CRASHING_OOM" "JOINED_GROUP" "MONGOT_NOT_CRASHING_OOM" "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK" "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" "NO_PRIMARY" "OUTSIDE_METRIC_THRESHOLD" "PENDING_INVOICE_OVER_THRESHOLD" "PRIMARY_ELECTED" "REMOVED_FROM_GROUP" "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" "TOO_MANY_ELECTIONS" "USERS_WITHOUT_MULTI_FACTOR_AUTH"

Category of incident recorded at this moment in time.
includeRaw
boolean
Default: false

Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.

maxDate
string <date-time> ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC.

minDate
string <date-time> ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...
Example: minDate=2021-11-17T23:15:00.060Z

Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return One Event from One Organization

Returns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.

This resource remains under revision and may change. Refer to the legacy documentation for this resource.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

eventId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the event that you want to return.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

includeRaw
boolean
Default: false

Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event.

Responses

Response samples

Content type
application/json
{
  • "alertConfigId": "adddde5af4ee4bd0b519375f",
  • "alertId": "d268e3a6e1718c6c36376f73",
  • "apiKeyId": "69f24ec71f746985759551c7",
  • "collection": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "currentValue": {
    },
  • "database": "string",
  • "endpointId": "05fcbefce5dd1c8ee5ebf7bf",
  • "eventTypeName": "AWS_ENCRYPTION_KEY_NEEDS_ROTATION",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "375db9d4f7a4c3e01714d02a",
  • "invoiceId": "217a865625b2bad3b9a1e93d",
  • "isGlobalAdmin": false,
  • "links": [ ],
  • "metricName": "ASSERT_REGULAR",
  • "opType": "string",
  • "orgId": "4888442a3354817a7320eb61",
  • "paymentId": "6fb669797183aa180bc5c09a",
  • "port": 0,
  • "providerEndpointId": "string",
  • "publicKey": "stringst",
  • "raw": "string",
  • "remoteAddress": "string",
  • "replicaSetName": "string",
  • "shardName": "string",
  • "targetPublicKey": "string",
  • "targetUsername": "user@example.com",
  • "teamId": "e254e4ade2206f4520d4107d",
  • "userId": "887821d389de9fe084df2bdf",
  • "username": "user@example.com",
  • "whitelistEntry": "string"
}

Federated Authentication

Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.

Delete the federation settings instance.

Deletes the federation settings instance and all associated data, including identity providers and domains. To use this resource, the requesting API Key must have the Organization Owner role in the last remaining connected organization. This resource doesn't require the API Key to have an Access List. Note: requests to this resource will fail if there is more than one connected organization in the federation.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
federationSettingsId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 55fa922fb343282757d9554e

Unique 24-hexadecimal digit string that identifies your federation.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return All Connected Org Configs from the Federation

Returns all connected org configs in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected orgs. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
federationSettingsId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 55fa922fb343282757d9554e

Unique 24-hexadecimal digit string that identifies your federation.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Remove One Org Config Connected to One Federation

Removes one connected organization configuration from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This resource doesn't require the API Key to have an Access List. Note: This request fails if only one connected organization exists in the federation.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
federationSettingsId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 55fa922fb343282757d9554e

Unique 24-hexadecimal digit string that identifies your federation.

orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Org Config Connected to One Federation

Returns the specified connected org config from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
federationSettingsId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 55fa922fb343282757d9554e

Unique 24-hexadecimal digit string that identifies your federation.

orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the connected organization configuration to return.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "domainAllowList": [
    ],
  • "domainRestrictionEnabled": true,
  • "identityProviderId": "stringstringstringst",
  • "orgId": "4888442a3354817a7320eb61",
  • "postAuthRoleGrants": [
    ],
  • "roleMappings": [
    ],
  • "userConflicts": [
    ]
}

Update one connected organization configuration in the specified federation.

Updates one connected organization configuration from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This resource doesn't require the API Key to have an Access List.

Note If the organization configuration has no associated identity provider, you can't use this resource to update role mappings or post authorization role grants.

Note: The domainRestrictionEnabled field defaults to false if not provided in the request.

Note: If the identityProviderId field is not provided, you will disconnect the organization and the identity provider.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
federationSettingsId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 55fa922fb343282757d9554e

Unique 24-hexadecimal digit string that identifies your federation.

orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the connected organization configuration to update.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Request Body schema: application/json

The connected organization configuration that you want to update.

domainAllowList
Array of strings unique

Approved domains that restrict users who can join the organization based on their email address.

domainRestrictionEnabled
required
boolean

Value that indicates whether domain restriction is enabled for this connected org.

identityProviderId
required
string = 20 characters ^([a-f0-9]{20})$

Unique 20-hexadecimal digit string that identifies the identity provider that this connected org config is associated with.

postAuthRoleGrants
Array of strings unique
Items Enum: "GLOBAL_AUTOMATION_ADMIN" "GLOBAL_BACKUP_ADMIN" "GLOBAL_METERING_USER" "GLOBAL_METRICS_INTERNAL_USER" "GLOBAL_MONITORING_ADMIN" "GLOBAL_OWNER" "GLOBAL_READ_ONLY" "GLOBAL_USER_ADMIN" "GLOBAL_USER_READ_ONLY" "GLOBAL_ACCOUNT_SUSPENSION_ADMIN" "GLOBAL_BILLING_ADMIN" "GLOBAL_LEGAL_ADMIN" "GLOBAL_FEATURE_FLAG_ADMIN" "GLOBAL_ATLAS_TSE" "GLOBAL_ATLAS_OPERATOR" "GLOBAL_ATLAS_ADMIN" "GLOBAL_STITCH_ADMIN" "GLOBAL_CHARTS_ADMIN" "GLOBAL_EXPERIMENT_ASSIGNMENT_USER" "GLOBAL_STITCH_INTERNAL_ADMIN" "GLOBAL_SECURITY_ADMIN" "GLOBAL_QUERY_ENGINE_INTERNAL_ADMIN" "GLOBAL_PROACTIVE_SUPPORT_ADMIN" "GLOBAL_INFRASTRUCTURE_INTERNAL_ADMIN" "GLOBAL_SALESFORCE_ADMIN" "GLOBAL_SALESFORCE_READ_ONLY" "GLOBAL_APP_SERVICES_CLUSTER_DEBUG_DATA_ACCESS" "ORG_MEMBER" "ORG_READ_ONLY" "ORG_BILLING_ADMIN" "ORG_GROUP_CREATOR" "ORG_OWNER" "GROUP_AUTOMATION_ADMIN" "GROUP_BACKUP_ADMIN" "GROUP_MONITORING_ADMIN" "GROUP_OWNER" "GROUP_READ_ONLY" "GROUP_USER_ADMIN" "GROUP_BILLING_ADMIN" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_CHARTS_ADMIN" "GROUP_CLUSTER_MANAGER" "GROUP_SEARCH_INDEX_EDITOR"

Atlas roles that are granted to a user in this organization after authenticating.

Array of objects (Federated Authentication Role Mapping) unique

Role mappings that are configured in this organization.
Array of objects (Federated User)

List that contains the users who have an email address that doesn't match any domain on the allowed list.

Responses

Request samples

Content type
application/json
{
  • "domainAllowList": [
    ],
  • "domainRestrictionEnabled": true,
  • "identityProviderId": "stringstringstringst",
  • "postAuthRoleGrants": [
    ],
  • "roleMappings": [
    ],
  • "userConflicts": [
    ]
}

Response samples

Content type
application/json
{
  • "domainAllowList": [
    ],
  • "domainRestrictionEnabled": true,
  • "identityProviderId": "stringstringstringst",
  • "orgId": "4888442a3354817a7320eb61",
  • "postAuthRoleGrants": [
    ],
  • "roleMappings": [
    ],
  • "userConflicts": [
    ]
}

Return All Role Mappings from One Organization

Returns all role mappings from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
federationSettingsId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 55fa922fb343282757d9554e

Unique 24-hexadecimal digit string that identifies your federation.

orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add One Role Mapping to One Organization

Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
federationSettingsId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 55fa922fb343282757d9554e

Unique 24-hexadecimal digit string that identifies your federation.

orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Request Body schema: application/json

The role mapping that you want to create.

externalGroupName
required
string [ 1 .. 200 ] characters

Unique human-readable label that identifies the identity provider group to whichthis role mapping applies.

required
Array of objects (RoleAssignment) unique

Atlas roles and the unique identifiers of the groups and organizations associated with each role.

Responses

Request samples

Content type
application/json
{
  • "externalGroupName": "string",
  • "roleAssignments": [
    ]
}

Response samples

Content type
application/json
{
  • "externalGroupName": "string",
  • "id": "4faca5b098702de1952f4d09",
  • "roleAssignments": [
    ]
}

Remove One Role Mapping from One Organization

Removes one role mapping in the specified organization from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
federationSettingsId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 55fa922fb343282757d9554e

Unique 24-hexadecimal digit string that identifies your federation.

id
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4faca5b098702de1952f4d09

Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove.

orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Role Mapping from One Organization

Returns one role mapping from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
federationSettingsId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 55fa922fb343282757d9554e

Unique 24-hexadecimal digit string that identifies your federation.

id
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4faca5b098702de1952f4d09

Unique 24-hexadecimal digit string that identifies the role mapping that you want to return.

orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "externalGroupName": "string",
  • "id": "4faca5b098702de1952f4d09",
  • "roleAssignments": [
    ]
}

Update One Role Mapping in One Organization

Updates one role mapping in the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
federationSettingsId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 55fa922fb343282757d9554e

Unique 24-hexadecimal digit string that identifies your federation.

id
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4faca5b098702de1952f4d09

Unique 24-hexadecimal digit string that identifies the role mapping that you want to update.

orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Request Body schema: application/json

The role mapping that you want to update.

externalGroupName
required
string [ 1 .. 200 ] characters

Unique human-readable label that identifies the identity provider group to whichthis role mapping applies.

required
Array of objects (RoleAssignment) unique

Atlas roles and the unique identifiers of the groups and organizations associated with each role.

Responses

Request samples

Content type
application/json
{
  • "externalGroupName": "string",
  • "roleAssignments": [
    ]
}

Response samples

Content type
application/json
{
  • "externalGroupName": "string",
  • "id": "4faca5b098702de1952f4d09",
  • "roleAssignments": [
    ]
}

Return all identity providers from the specified federation.

Returns all identity providers in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
federationSettingsId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 55fa922fb343282757d9554e

Unique 24-hexadecimal digit string that identifies your federation.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return one identity provider from the specified federation.

Returns one identity provider from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
federationSettingsId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 55fa922fb343282757d9554e

Unique 24-hexadecimal digit string that identifies your federation.

identityProviderId
required
string = 20 characters ^([a-f0-9]{20})$
Example: c2777a9eca931f29fc2f

Unique 20-hexadecimal digit string that identifies the identity provider.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "acsUrl": "string",
  • "associatedDomains": [
    ],
  • "associatedOrgs": [
    ],
  • "audienceUri": "string",
  • "displayName": "string",
  • "issuerUri": "string",
  • "oktaIdpId": "stringstringstringst",
  • "pemFileInfo": [
    ],
  • "requestBinding": "string",
  • "responseSignatureAlgorithm": "string",
  • "ssoDebugEnabled": true,
  • "ssoUrl": "string",
  • "status": "string"
}

Update the identity provider.

Updates one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
federationSettingsId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 55fa922fb343282757d9554e

Unique 24-hexadecimal digit string that identifies your federation.

identityProviderId
required
string = 20 characters ^([a-f0-9]{20})$
Example: c2777a9eca931f29fc2f

Unique 20-hexadecimal digit string that identifies the identity provider.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Request Body schema: application/json

The identity provider that you want to update.

associatedDomains
Array of strings unique

List that contains the domains associated with the identity provider.

displayName
string [ 1 .. 50 ] characters

Human-readable label that identifies the identity provider.
issuerUri
string

Unique string that identifies the issuer of the SAML Assertion.
Array of objects (PemFileInfo)

List that contains the PEM file information for the identity provider's certificates.

requestBinding
string
Enum: "HTTP-POST" "HTTP-REDIRECT"

SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request.

responseSignatureAlgorithm
string
Enum: "SHA-1" "SHA-256"

Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.

ssoDebugEnabled
required
boolean

Flag that indicates whether the identity provider has SSO debug enabled.

ssoUrl
string

Unique string that identifies the intended audience of the SAML assertion.

status
string
Enum: "ACTIVE" "INACTIVE"

String enum that indicates whether the identity provider is active.

Responses

Request samples

Content type
application/json
{
  • "associatedDomains": [
    ],
  • "displayName": "string",
  • "issuerUri": "urn:idp:default",
  • "pemFileInfo": [
    ],
  • "requestBinding": "HTTP-POST",
  • "responseSignatureAlgorithm": "SHA-1",
  • "ssoDebugEnabled": true,
  • "ssoUrl": "https://example.com",
  • "status": "ACTIVE"
}

Response samples

Content type
application/json
{
  • "acsUrl": "string",
  • "associatedDomains": [
    ],
  • "associatedOrgs": [
    ],
  • "audienceUri": "string",
  • "displayName": "string",
  • "issuerUri": "string",
  • "oktaIdpId": "stringstringstringst",
  • "pemFileInfo": [
    ],
  • "requestBinding": "string",
  • "responseSignatureAlgorithm": "string",
  • "ssoDebugEnabled": true,
  • "ssoUrl": "string",
  • "status": "string"
}

Return the metadata of one identity provider in the specified federation.

Returns the metadata of one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
federationSettingsId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 55fa922fb343282757d9554e

Unique 24-hexadecimal digit string that identifies your federation.

identityProviderId
required
string = 20 characters ^([a-f0-9]{20})$
Example: c2777a9eca931f29fc2f

Unique 20-hexadecimal digit string that identifies the identity provider.

Responses

Response samples

Content type
application/json
"string"

Return Federation Settings for One Organization

Returns information about the federation settings for the specified organization. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "federatedDomains": [
    ],
  • "hasRoleMappings": true,
  • "id": "55fa922fb343282757d9554e",
  • "identityProviderId": "c2777a9eca931f29fc2f",
  • "identityProviderStatus": "string"
}

Global Clusters

Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings.

Return All Global Clusters Data

Returns all managed namespaces and custom zone mappings for the specified global cluster. Managed namespaces identify collections using the database name, the dot separator, and the collection name. Custom zone mappings matches ISO 3166-2 location codes to zones in your global cluster. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

Global Clusters
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies this global cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ]
}

Remove All Custom Zone Mappings from One Global Cluster

Removes all custom zone mappings for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. Removing the custom zone mappings restores the default mapping. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

Global Clusters
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies this global cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ]
}

Add Custom Zone Mappings to One Global Cluster

Add one or more custom zone mappings to the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

Global Clusters
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies this global cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Custom zone mapping to add to the specified global cluster.

required
Array of objects (Global Cluster Zone)

List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to the human-readable label for the desired custom zone. MongoDB Cloud maps the ISO 3166-1a2 code to the nearest geographical zone by default. Include this parameter to override the default mappings.

This parameter returns an empty object if no custom zones exist.

Responses

Request samples

Content type
application/json
{
  • "customZoneMappings": [
    ]
}

Response samples

Content type
application/json
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ]
}

Remove One Managed Namespace from One Global Cluster

Removes one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. Deleting a managed namespace does not remove the associated collection or data. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.

Global Clusters
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies this global cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

db
string

Human-readable label that identifies the database that contains the collection.

collection
string

Human-readable label that identifies the collection associated with the managed namespace.

Responses

Response samples

Content type
application/json
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ]
}

Create One Managed Namespace in One Global Cluster

Creates one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.

Global Clusters
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies this global cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Managed namespace to create within the specified global cluster.

collection
required
string

Human-readable label of the collection to manage for this Global Cluster.

db
required
string

Human-readable label of the database to manage for this Global Cluster.

isCustomShardKeyHashed
boolean
Default: false

Flag that indicates whether someone hashed the custom shard key for the specified collection. If you set this value to false, MongoDB Cloud uses ranged sharding.

Hashed Shard Keys
isShardKeyUnique
boolean
Default: false

Flag that indicates whether someone hashed the custom shard key. If this parameter returns false, this cluster uses ranged sharding.

numInitialChunks
number <= 8192 ^[0-9]+$

Minimum number of chunks to create initially when sharding an empty collection with a hashed shard key.

Global Cluster Sharding
presplitHashedZones
boolean
Default: false

Flag that indicates whether MongoDB Cloud should create and distribute initial chunks for an empty or non-existing collection. MongoDB Cloud distributes data based on the defined zones and zone ranges for the collection.

Hashed Shard Key

Responses

Request samples

Content type
application/json
{
  • "collection": "string",
  • "db": "string",
  • "isCustomShardKeyHashed": false,
  • "isShardKeyUnique": false,
  • "numInitialChunks": 8192,
  • "presplitHashedZones": false
}

Response samples

Content type
application/json
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ]
}

Remove All Custom Zone Mappings from One Global Multi-Cloud Cluster

Removes all custom zone mappings for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. Removing the custom zone mappings restores the default mapping. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies this advanced cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ]
}

Remove One Managed Namespace from One Global Multi-Cloud Cluster

Removes one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. Deleting a managed namespace does not remove the associated collection or data. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies this advanced cluster.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

db
string

Human-readable label that identifies the database that contains the collection.

collection
string

Human-readable label that identifies the collection associated with the managed namespace.

Responses

Response samples

Content type
application/json
{
  • "customZoneMapping": {
    },
  • "managedNamespaces": [
    ]
}

Invoices

Returns invoices.

Return All Invoices for One Organization

Returns all invoices that MongoDB issued to the specified organization. This list includes all invoices regardless of invoice status. To use this resource, the requesting API Key must have the Organization Member role. If you have a cross-organization setup, to view linked invoices, you must have an Organization Billing Admin or Organization Owner role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "links": [ ],
  • "results": [
    ],
  • "totalCount": 0
}

Return All Pending Invoices for One Organization

Returns all invoices accruing charges for the current billing cycle for the specified organization. To use this resource, the requesting API Key must have the Organization Member role. If you have a cross-organization setup, to view linked invoices, you must have an Organization Billing Admin or Organization Owner Role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "links": [ ],
  • "results": [
    ],
  • "totalCount": 0
}

Return One Organization Invoice

Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. To use this resource, the requesting API Key must have the Organization Member role. If you have a cross-organization setup, you can query for a linked invoice if you have an Organization Billing Admin or Organization Owner role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

invoiceId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

header Parameters
Accept
string
Default: application/json
Enum: "application/json" "text/csv"

Indicates which content types the client is able to understand. Expressed as MIME types.

Responses

Response samples

Content type
{
  • "amountBilledCents": 0,
  • "amountPaidCents": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "creditsCents": 0,
  • "endDate": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "217a865625b2bad3b9a1e93d",
  • "lineItems": [
    ],
  • "linkedInvoices": [
    ],
  • "links": [ ],
  • "orgId": "4888442a3354817a7320eb61",
  • "payments": [
    ],
  • "refunds": [
    ],
  • "salesTaxCents": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "startingBalanceCents": 0,
  • "statusName": "string",
  • "subtotalCents": 0,
  • "updated": "2019-08-24T14:15:22Z"
}

Return One Organization Invoice as CSV

Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting API Key must have the Organization Member role. If you have a cross-organization setup, you can query for a linked invoice if you have an Organization Billing Admin or Organization Owner Role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

invoiceId
required
string[0-9a-f]+

Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "parameters": [
    ],
  • "reason": "Unauthorized"
}

LDAP Configuration

Returns, edits, verifies, and removes LDAP configurations.

Return the Current LDAP or X.509 Configuration

Returns the current LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Edit the LDAP or X.509 Configuration

Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

Updating this configuration triggers a rolling restart of the database.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Updates the LDAP configuration for the specified project.

object (Database User TLS Certificate Settings)

Settings to configure TLS Certificates for database users.
object (LDAP Security Settings)

Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details that apply to the specified project.

Responses

Request samples

Content type
application/json
{
  • "customerX509": {
    },
  • "ldap": {
    }
}

Response samples

Content type
application/json
{ }

Remove the Current LDAP User to DN Mapping

Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  • "error": 404,
  • "errorCode": "RESOURCE_NOT_FOUND",
  • "parameters": [
    ],
  • "reason": "Not Found"
}

Verify the LDAP Configuration in One Project

Verifies the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

The LDAP configuration for the specified project that you want to verify.

authzQueryTemplate
string
Default: "{USER}?memberOf?base"

Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud applies to create an LDAP query to return the LDAP groups associated with the authenticated MongoDB user. MongoDB Cloud uses this parameter only for user authorization.

Use the {USER} placeholder in the Uniform Resource Locator (URL) to substitute the authenticated username. The query relates to the host specified with the hostname. Format this query per RFC 4515 and RFC 4516.

bindPassword
string

Password that MongoDB Cloud uses to authenticate the bindUsername.

bindUsername
required
string^(?:(?<cn>CN=(?<name>[^,]*)),)?(?:(?<path>(?:...

Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253.

RFC 2253
caCertificate
string

Certificate Authority (CA) certificate that MongoDB Cloud uses to verify the identity of the Lightweight Directory Access Protocol (LDAP) host. MongoDB Cloud allows self-signed certificates. To delete an assigned value, pass an empty string: "caCertificate": ""

hostname
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...

Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster.

port
required
number
Default: 636

IANA port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections.

Responses

Request samples

Content type
application/json
{
  • "authzQueryTemplate": "{USER}?memberOf?base",
  • "bindPassword": "string",
  • "bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
  • "caCertificate": "string",
  • "hostname": "string",
  • "port": 636
}

Response samples

Content type
application/json
{ }

Return the Status of One Verify LDAP Configuration Request

Returns the status of one request to verify one LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

requestId
required
string = 24 characters ^([a-f0-9]{24})$

Unique string that identifies the request to verify an LDAP configuration.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Legacy Backup Snapshots

Returns, removes, and edits the expiration date of Legacy Backup snapshots.

Return All Legacy Backup Snapshots Deprecated

Returns all legacy backup snapshots for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Remove One Legacy Backup Snapshot Deprecated

Removes one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
snapshotId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the desired snapshot.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Legacy Backup Snapshot Deprecated

Returns one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
snapshotId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the desired snapshot.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "clusterId": "5faec72692cee15b51eb22a4",
  • "complete": true,
  • "created": {
    },
  • "doNotDelete": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "78e18e587716102f711a5bca",
  • "lastOplogAppliedTimestamp": {
    },
  • "links": [ ],
  • "parts": [
    ]
}

Change One Legacy Backup Snapshot Expiration Deprecated

Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
snapshotId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the desired snapshot.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Changes One Legacy Backup Snapshot Expiration.

doNotDelete
boolean

Flag that indicates whether someone can delete this snapshot. You can't set "doNotDelete" : true and set a timestamp for expires in the same request.

expires
string <date-time> ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Date and time when MongoDB Cloud deletes the snapshot. If "doNotDelete" : true, MongoDB Cloud removes any value set for this parameter.

Responses

Request samples

Content type
application/json
{
  • "doNotDelete": true,
  • "expires": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "clusterId": "5faec72692cee15b51eb22a4",
  • "complete": true,
  • "created": {
    },
  • "doNotDelete": true,
  • "expires": "2019-08-24T14:15:22Z",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "78e18e587716102f711a5bca",
  • "lastOplogAppliedTimestamp": {
    },
  • "links": [ ],
  • "parts": [
    ]
}

Legacy Backup Restore Jobs

Returns and adds restore jobs for database deployments that use Legacy Backups.

Return All Legacy Backup Restore Jobs Deprecated

Returns all legacy backup restore jobs for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster with the snapshot you want to return.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

batchId
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the batch of restore jobs to return. Timestamp in ISO 8601 date and time format in UTC when creating a restore job for a sharded cluster, Application creates a separate job for each shard, plus another for the config host. Each of these jobs comprise one batch. A restore job for a replica set can't be part of a batch.

Responses

Response samples

Content type
application/json
{ }

Create One Legacy Backup Restore Job Deprecated

Restores one legacy backup for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster with the snapshot you want to return.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Legacy backup to restore to one cluster in the specified project.

checkpointId
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the sharded cluster checkpoint. The checkpoint represents the point in time back to which you want to restore you data. This parameter applies when "delivery.methodName" : "AUTOMATED_RESTORE". Use this parameter with sharded clusters only.

  • If you set checkpointId, you can't set oplogInc, oplogTs, snapshotId, or pointInTimeUTCMillis.
  • If you provide this parameter, this endpoint restores all data up to this checkpoint to the database you specify in the delivery object.
required
object (Restore Snapshot Delivery Metadata)

Method and details that indicate how to deliver the restored snapshot data.

oplogInc
number >= 1

Thirty-two-bit incrementing ordinal that represents operations within a given second. When paired with oplogTs, this represents the point in time to which MongoDB Cloud restores your data. This parameter applies when "delivery.methodName" : "AUTOMATED_RESTORE".

  • If you set oplogInc, you must set oplogTs, and can't set checkpointId, snapshotId, or pointInTimeUTCMillis.
  • If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the delivery object.
oplogTs
string^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9...

Date and time from which you want to restore this snapshot. This parameter expresses its value in ISO 8601 format in UTC. This represents the first part of an Oplog timestamp. When paired with oplogInc, they represent the last database operation to which you want to restore your data. This parameter applies when "delivery.methodName" : "AUTOMATED_RESTORE". Run a query against local.oplog.rs on your replica set to find the desired timestamp.

  • If you set oplogTs, you must set oplogInc, and you can't set checkpointId, snapshotId, or pointInTimeUTCMillis.
  • If you provide this parameter, this endpoint restores all data up to and including this Oplog timestamp to the database you specified in the delivery object.
pointInTimeUTCMillis
number >= 12 characters >= 1199145600000

Timestamp from which you want to restore this snapshot. This parameter expresses its value in the number of milliseconds elapsed since the UNIX epoch. This timestamp must fall within the last 24 hours of the current time. This parameter applies when "delivery.methodName" : "AUTOMATED_RESTORE".

  • If you provide this parameter, this endpoint restores all data up to this point in time to the database you specified in the delivery object.
  • If you set pointInTimeUTCMillis, you can't set oplogInc, oplogTs, snapshotId, or checkpointId.
snapshotId
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the snapshot to restore. If you set snapshotId, you can't set oplogInc, oplogTs, pointInTimeUTCMillis, or checkpointId.

Responses

Request samples

Content type
application/json
{
  • "checkpointId": "866164af7f46083e4f3a964b",
  • "delivery": {
    },
  • "oplogInc": 1,
  • "oplogTs": "string",
  • "pointInTimeUTCMillis": 1199145600000,
  • "snapshotId": "78e18e587716102f711a5bca"
}

Response samples

Content type
application/json
{ }

Return One Legacy Backup Restore Job Deprecated

Returns one legacy backup restore job for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster with the snapshot you want to return.

jobId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the restore job.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Legacy Backup Checkpoints

Returns Legacy Backup Checkpoint metadata. Checkpoints serve as additional restore points for sharded clusters at points in time between regular snapshots.

Return All Legacy Backup Checkpoints Deprecated

Returns all legacy backup checkpoints for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster that contains the checkpoints that you want to return.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
[ ]

Return One Legacy Backup Checkpoint Deprecated

Returns one legacy backup checkpoint for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

checkpointId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the checkpoint.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster that contains the checkpoints that you want to return.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Legacy Backup Snapshot Schedule

Returns and edits Legacy Backup snapshot schedules.

Return One Snapshot Schedule Deprecated

Returns the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster with the snapshot you want to return.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Update Snapshot Schedule for One Cluster Deprecated

Update the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster with the snapshot you want to return.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Update the snapshot schedule for one cluster in the specified project.

clusterCheckpointIntervalMin
required
number
Enum: 15 30 60

Quantity of time expressed in minutes between successive cluster checkpoints. This parameter applies only to sharded clusters. This number determines the granularity of continuous cloud backups for sharded clusters.

clusterId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return.

dailySnapshotRetentionDays
required
number
Enum: 0 3 4 5 6 7 15 30 60 90 120 180 360

Quantity of time to keep daily snapshots. MongoDB Cloud expresses this value in days. Set this value to 0 to disable daily snapshot retention.

monthlySnapshotRetentionMonths
required
number
Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 18 24 36

Number of months that MongoDB Cloud must keep monthly snapshots. Set this value to 0 to disable monthly snapshot retention.

pointInTimeWindowHours
required
number

Number of hours before the current time from which MongoDB Cloud can create a Continuous Cloud Backup snapshot.

snapshotIntervalHours
required
number
Enum: 6 8 12 24

Number of hours that must elapse before taking another snapshot.

snapshotRetentionDays
required
number
Enum: 2 3 4 5

Number of days that MongoDB Cloud must keep recent snapshots.
weeklySnapshotRetentionWeeks
required
number
Enum: 0 1 2 3 4 5 6 7 8 12 16 20 24 52

Number of weeks that MongoDB Cloud must keep weekly snapshots. Set this value to 0 to disable weekly snapshot retention.

Responses

Request samples

Content type
application/json
{
  • "clusterCheckpointIntervalMin": 15,
  • "clusterId": "5faec72692cee15b51eb22a4",
  • "dailySnapshotRetentionDays": 0,
  • "monthlySnapshotRetentionMonths": 0,
  • "pointInTimeWindowHours": 0,
  • "snapshotIntervalHours": 6,
  • "snapshotRetentionDays": 2,
  • "weeklySnapshotRetentionWeeks": 0
}

Response samples

Content type
application/json
{ }

Maintenance Windows

Returns, edits, and removes maintenance windows.

Reset One Maintenance Window for One Project

Resets the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role.This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Maintenance Window for One Project

Returns the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Read Only role.This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "autoDeferOnceEnabled": true,
  • "dayOfWeek": 1,
  • "hourOfDay": 23,
  • "startASAP": true
}

Update Maintenance Window for One Project

Updates the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role.This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Request Body schema: application/json

Updates the maintenance window for the specified project.

autoDeferOnceEnabled
boolean

Flag that indicates whether MongoDB Cloud should defer all maintenance windows for one week after you enable them.

dayOfWeek
required
number [ 1 .. 7 ]

One-based integer that represents the day of the week that the maintenance window starts.

Value Day of Week
1 Sunday
2 Monday
3 Tuesday
4 Wednesday
5 Thursday
6 Friday
7 Saturday
hourOfDay
required
number [ 0 .. 23 ]

Zero-based integer that represents the hour of the of the day that the maintenance window starts according to a 24-hour clock. Use 0 for midnight and 12 for noon.

startASAP
boolean

Flag that indicates whether MongoDB Cloud starts the maintenance window immediately upon receiving this request. To start the maintenance window immediately for your project, MongoDB Cloud must have maintenance scheduled and you must set a maintenance window. This flag resets to false after MongoDB Cloud completes maintenance.

Responses

Request samples

Content type
application/json
{
  • "autoDeferOnceEnabled": true,
  • "dayOfWeek": 1,
  • "hourOfDay": 23,
  • "startASAP": true
}

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Toggle Automatic Deferral of Maintenance for One Project

Toggles automatic deferral of the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Defer One Maintenance Window for One Project

Defers the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role.This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

MongoDB Cloud Users

Returns, adds, and edits MongoDB Cloud users.

Create One MongoDB Cloud User

Creates one MongoDB Cloud user account. A MongoDB Cloud user account only grants access to the MongoDB Cloud application. To grant database access, create a database user. To use this resource, the requesting API Key can have any role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

MongoDB Cloud user account to create.

country
required
string^([A-Z]{2})$

Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.

emailAddress
required
string^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$...

Email address that belongs to the MongoDB Cloud user.
firstName
required
string

First or given name that belongs to the MongoDB Cloud user.
lastName
required
string

Last name, family name, or surname that belongs to the MongoDB Cloud user.

mobileNumber
required
string(?:(?:\\+?1\\s*(?:[.-]\\s*)?)?(?:(\\s*([2-9]1...

Mobile phone number that belongs to the MongoDB Cloud user.
password
required
string >= 8 characters

Password applied with the username to log in to MongoDB Cloud. MongoDB Cloud does not return this parameter except in response to creating a new MongoDB Cloud user. Only the MongoDB Cloud user can update their password after it has been set from the MongoDB Cloud console.

required
Array of objects (Role Assignment)

List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. A role can apply to one organization or one project but not both.

username
required
string^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$...

Email address that represents the username of the MongoDB Cloud user.

Responses

Request samples

Content type
application/json
{
  • "country": "string",
  • "emailAddress": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "mobileNumber": "string",
  • "password": "stringst",
  • "roles": [
    ],
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "country": "string",
  • "createdAt": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,9})?(?:Z)$",
  • "emailAddress": "string",
  • "firstName": "string",
  • "id": "887821d389de9fe084df2bdf",
  • "lastAuth": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,9})?(?:Z)$",
  • "lastName": "string",
  • "links": [ ],
  • "mobileNumber": "string",
  • "password": "stringst",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "string"
}

Return One MongoDB Cloud User using Their Username

Returns the details for one MongoDB Cloud user account with the specified username. To use this resource, the requesting API Key can have any role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
userName
required
string^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%...

Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "country": "string",
  • "createdAt": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,9})?(?:Z)$",
  • "emailAddress": "string",
  • "firstName": "string",
  • "id": "887821d389de9fe084df2bdf",
  • "lastAuth": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,9})?(?:Z)$",
  • "lastName": "string",
  • "links": [ ],
  • "mobileNumber": "string",
  • "password": "stringst",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "string"
}

Return One MongoDB Cloud User using Its ID

Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. To use this resource, the requesting API Key can have any role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
userId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies this user.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "country": "string",
  • "createdAt": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,9})?(?:Z)$",
  • "emailAddress": "string",
  • "firstName": "string",
  • "id": "887821d389de9fe084df2bdf",
  • "lastAuth": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,9})?(?:Z)$",
  • "lastName": "string",
  • "links": [ ],
  • "mobileNumber": "string",
  • "password": "stringst",
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "string"
}

Monitoring and Logs

Returns database deployment monitoring and logging data.

Download Logs for One Cluster Host in One Project

Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Data Access Read Write roles. This resource doesn't require the API Key to have an Access List.

Global Clusters
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

hostName
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...

Human-readable label that identifies the host that stores the log files that you want to download.

logName
required
string
Enum: "mongodb" "mongos" "mongodb-audit-log" "mongos-audit-log"

Human-readable label that identifies the log file that you want to return. To return audit logs, enable Database Auditing for the specified project.

Set up Database Auditing
query Parameters
endDate
number >= 1199145600

Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.

startDate
number >= 1199145600

Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return All Atlas Search Metric Types for One Process

Return all Atlas Search metric types available for one process in the specified project.

path Parameters
processId
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example: my.host.name.com:27017

Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{ }

Return All Atlas Search Index Metrics for One Namespace

Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process.

path Parameters
processId
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example: my.host.name.com:27017

Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

databaseName
required
string
Example: mydb

Human-readable label that identifies the database.
collectionName
required
string
Example: mycoll

Human-readable label that identifies the collection.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
granularity
required
string
Example: granularity=PT1M

Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.

period
string
Example: period=PT10H

Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.

start
string <date-time> ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.

end
string <date-time> ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.

envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

metrics
required
Array of strings <= 10 items unique
Items Enum: "INDEX_SIZE_ON_DISK" "NUMBER_OF_DELETES" "NUMBER_OF_ERROR_QUERIES" "NUMBER_OF_GETMORE_COMMANDS" "NUMBER_OF_INDEX_FIELDS" "NUMBER_OF_INSERTS" "NUMBER_OF_SUCCESS_QUERIES" "NUMBER_OF_UPDATES" "REPLICATION_LAG" "TOTAL_NUMBER_OF_QUERIES"

List that contains the measurements that MongoDB Atlas reports for the associated data series.

Responses

Response samples

Content type
application/json
{ }

Return Atlas Search Metrics for One Index in One Specified Namespace

Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process.

path Parameters
processId
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example: my.host.name.com:27017

Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

indexName
required
string
Example: myindex

Human-readable label that identifies the index.
databaseName
required
string
Example: mydb

Human-readable label that identifies the database.
collectionName
required
string
Example: mycoll

Human-readable label that identifies the collection.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
granularity
required
string
Example: granularity=PT1M

Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.

period
string
Example: period=PT10H

Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.

start
string <date-time> ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.

end
string <date-time> ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.

envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

metrics
required
Array of strings <= 10 items unique
Items Enum: "INDEX_SIZE_ON_DISK" "NUMBER_OF_DELETES" "NUMBER_OF_ERROR_QUERIES" "NUMBER_OF_GETMORE_COMMANDS" "NUMBER_OF_INDEX_FIELDS" "NUMBER_OF_INSERTS" "NUMBER_OF_SUCCESS_QUERIES" "NUMBER_OF_UPDATES" "REPLICATION_LAG" "TOTAL_NUMBER_OF_QUERIES"

List that contains the measurements that MongoDB Atlas reports for the associated data series.

Responses

Response samples

Content type
application/json
{ }

Return Atlas Search Hardware and Status Metrics

Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project.

path Parameters
processId
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example: my.host.name.com:27017

Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
granularity
required
string
Example: granularity=PT1M

Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC.

period
string
Example: period=PT10H

Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end.

start
string <date-time> ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.

end
string <date-time> ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period.

envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

metrics
required
Array of strings <= 10 items unique
Items Enum: "FTS_DISK_USAGE" "FTS_PROCESS_CPU_KERNEL" "FTS_PROCESS_CPU_USER" "FTS_PROCESS_NORMALIZED_CPU_KERNEL" "FTS_PROCESS_NORMALIZED_CPU_USER" "FTS_PROCESS_RESIDENT_MEMORY" "FTS_PROCESS_SHARED_MEMORY" "FTS_PROCESS_VIRTUAL_MEMORY" "JVM_CURRENT_MEMORY" "JVM_MAX_MEMORY"

List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series.

Responses

Response samples

Content type
application/json
{ }

Return All MongoDB Processes in One Project

Returns details of all processes for the specified project. A MongoDB process can be either a mongod or mongos. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Return One MongoDB Process by ID

Returns the processes for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

processId
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example: mongodb.example.com:27017

Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Return Available Databases for One MongoDB Process

Returns the list of databases running on the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

processId
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example: mongodb.example.com:27017

Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Return One Database for a MongoDB Process

Returns one database running on the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

databaseName
required
string

Human-readable label that identifies the database that the specified MongoDB process serves.

processId
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example: mongodb.example.com:27017

Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Return Measurements of One Database for One MongoDB Process

Returns the measurements of one database for the specified host for the specified project. Returns the database's on-disk storage space based on the MongoDB dbStats command output. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

databaseName
required
string

Human-readable label that identifies the database that the specified MongoDB process serves.

processId
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example: mongodb.example.com:27017

Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

m
Array of strings [ 1 .. 10 ] items unique
Items Enum: "DATABASE_AVERAGE_OBJECT_SIZE" "DATABASE_COLLECTION_COUNT" "DATABASE_DATA_SIZE" "DATABASE_STORAGE_SIZE" "DATABASE_INDEX_SIZE" "DATABASE_INDEX_COUNT" "DATABASE_EXTENT_COUNT" "DATABASE_OBJECT_COUNT" "DATABASE_VIEW_COUNT"

One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for m, repeat the m parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.

Responses

Response samples

Content type
application/json
{ }

Return Available Disks for One MongoDB Process

Returns the list of disks or partitions for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

processId
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example: mongodb.example.com:27017

Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Return Measurements of One Disk

Returns the measurements of one disk or partition for the specified host for the specified project. Returned value can be one of the following:

  • Throughput of I/O operations for the disk partition used for the MongoDB process
  • Percentage of time during which requests the partition issued and serviced
  • Latency per operation type of the disk partition used for the MongoDB process
  • Amount of free and used disk space on the disk partition used for the MongoDB process

To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
partitionName
required
string

Human-readable label of the disk or partition to which the measurements apply.

groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

processId
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example: mongodb.example.com:27017

Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{ }

Return Measurements of One Disk for One MongoDB Process

Returns the measurements of one disk or partition for the specified host for the specified project. Returned value can be one of the following:

  • Throughput of I/O operations for the disk partition used for the MongoDB process
  • Percentage of time during which requests the partition issued and serviced
  • Latency per operation type of the disk partition used for the MongoDB process
  • Amount of free and used disk space on the disk partition used for the MongoDB process

To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

partitionName
required
string

Human-readable label of the disk or partition to which the measurements apply.

processId
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example: mongodb.example.com:27017

Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

m
Array of strings [ 1 .. 10 ] items unique
Items Enum: "DISK_PARTITION_IOPS_READ" "MAX_DISK_PARTITION_IOPS_READ" "DISK_PARTITION_IOPS_WRITE" "MAX_DISK_PARTITION_IOPS_WRITE" "DISK_PARTITION_IOPS_TOTAL" "MAX_DISK_PARTITION_IOPS_TOTAL" "DISK_PARTITION_UTILIZATION" "MAX_DISK_PARTITION_UTILIZATION" "DISK_PARTITION_LATENCY_READ" "MAX_DISK_PARTITION_LATENCY_READ" "DISK_PARTITION_LATENCY_WRITE" "MAX_DISK_PARTITION_LATENCY_WRITE" "DISK_PARTITION_SPACE_FREE" "MAX_DISK_PARTITION_SPACE_FREE" "DISK_PARTITION_SPACE_USED" "MAX_DISK_PARTITION_SPACE_USED" "DISK_PARTITION_SPACE_PERCENT_FREE" "MAX_DISK_PARTITION_SPACE_PERCENT_FREE" "DISK_PARTITION_SPACE_PERCENT_USED" "MAX_DISK_PARTITION_SPACE_PERCENT_USED"

One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for m, repeat the m parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.

Responses

Response samples

Content type
application/json
{ }

Return Measurements for One MongoDB Process

Returns measurements of the disk or partition per process for the specified host for the specified project. Returned value can be one of the following:

  • Throughput of I/O operations for the disk partition used for the MongoDB process
  • Percentage of time during which requests the partition issued and serviced
  • Latency per operation type of the disk partition used for the MongoDB process
  • Amount of free and used disk space on the disk partition used for the MongoDB process

To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

processId
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example: mongodb.example.com:27017

Combination of hostname and Internet Assigned Numbers Authority (IANA) port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

m
Array of strings [ 1 .. 10 ] items unique
Items Enum: "ASSERT_MSG" "ASSERT_REGULAR" "ASSERT_USER" "ASSERT_WARNING" "BACKGROUND_FLUSH_AVG" "CACHE_BYTES_READ_INTO" "CACHE_BYTES_WRITTEN_FROM" "CACHE_DIRTY_BYTES" "CACHE_USED_BYTES" "COMPUTED_MEMORY" "CONNECTIONS" "CURSORS_TOTAL_OPEN" "CURSORS_TOTAL_TIMED_OUT" "DB_DATA_SIZE_TOTAL" "DB_STORAGE_TOTAL" "DOCUMENT_METRICS_DELETED" "DOCUMENT_METRICS_INSERTED" "DOCUMENT_METRICS_RETURNED" "DOCUMENT_METRICS_UPDATED" "EXTRA_INFO_PAGE_FAULTS" "FTS_DISK_UTILIZATION" "FTS_MEMORY_MAPPED" "FTS_MEMORY_RESIDENT" "FTS_MEMORY_VIRTUAL" "FTS_PROCESS_CPU_KERNEL" "FTS_PROCESS_CPU_USER" "FTS_PROCESS_NORMALIZED_CPU_KERNEL" "FTS_PROCESS_NORMALIZED_CPU_USER" "GLOBAL_ACCESSES_NOT_IN_MEMORY" "GLOBAL_LOCK_CURRENT_QUEUE_READERS" "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" "INDEX_COUNTERS_BTREE_ACCESSES" "INDEX_COUNTERS_BTREE_HITS" "INDEX_COUNTERS_BTREE_MISS_RATIO" "INDEX_COUNTERS_BTREE_MISSES" "JOURNALING_COMMITS_IN_WRITE_LOCK" "JOURNALING_MB" "JOURNALING_WRITE_DATA_FILES_MB" "MAX_PROCESS_CPU_CHILDREN_KERNEL" "MAX_PROCESS_CPU_CHILDREN_USER" "MAX_PROCESS_CPU_KERNEL" "MAX_PROCESS_CPU_USER" "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL" "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER" "MAX_PROCESS_NORMALIZED_CPU_KERNEL" "MAX_PROCESS_NORMALIZED_CPU_USER" "MAX_SWAP_USAGE_FREE" "MAX_SWAP_USAGE_USED " "MAX_SYSTEM_CPU_GUEST" "MAX_SYSTEM_CPU_IOWAIT" "MAX_SYSTEM_CPU_IRQ" "MAX_SYSTEM_CPU_KERNEL" "MAX_SYSTEM_CPU_SOFTIRQ" "MAX_SYSTEM_CPU_STEAL" "MAX_SYSTEM_CPU_USER" "MAX_SYSTEM_MEMORY_AVAILABLE" "MAX_SYSTEM_MEMORY_FREE" "MAX_SYSTEM_MEMORY_USED" "MAX_SYSTEM_NETWORK_IN" "MAX_SYSTEM_NETWORK_OUT" "MAX_SYSTEM_NORMALIZED_CPU_GUEST" "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT" "MAX_SYSTEM_NORMALIZED_CPU_IRQ" "MAX_SYSTEM_NORMALIZED_CPU_KERNEL" "MAX_SYSTEM_NORMALIZED_CPU_NICE" "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ" "MAX_SYSTEM_NORMALIZED_CPU_STEAL" "MAX_SYSTEM_NORMALIZED_CPU_USER" "MEMORY_MAPPED" "MEMORY_RESIDENT" "MEMORY_VIRTUAL" "NETWORK_BYTES_IN" "NETWORK_BYTES_OUT" "NETWORK_NUM_REQUESTS" "OP_EXECUTION_TIME_COMMANDS" "OP_EXECUTION_TIME_READS" "OP_EXECUTION_TIME_WRITES" "OPCOUNTER_CMD" "OPCOUNTER_DELETE" "OPCOUNTER_GETMORE" "OPCOUNTER_INSERT" "OPCOUNTER_QUERY" "OPCOUNTER_REPL_CMD" "OPCOUNTER_REPL_DELETE" "OPCOUNTER_REPL_INSERT" "OPCOUNTER_REPL_UPDATE" "OPCOUNTER_UPDATE" "OPERATIONS_SCAN_AND_ORDER" "OPLOG_MASTER_LAG_TIME_DIFF" "OPLOG_MASTER_TIME" "OPLOG_RATE_GB_PER_HOUR" "OPLOG_SLAVE_LAG_MASTER_TIME" "OPLOG_REPLICATION_LAG" "PROCESS_CPU_CHILDREN_KERNEL" "PROCESS_CPU_CHILDREN_USER" "PROCESS_CPU_KERNEL" "PROCESS_CPU_USER" "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL" "PROCESS_NORMALIZED_CPU_CHILDREN_USER" "PROCESS_NORMALIZED_CPU_KERNEL" "PROCESS_NORMALIZED_CPU_USER" "QUERY_EXECUTOR_SCANNED" "QUERY_EXECUTOR_SCANNED_OBJECTS" "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" "QUERY_TARGETING_SCANNED_PER_RETURNED" "RESTARTS_IN_LAST_HOUR" "SWAP_USAGE_FREE" "SWAP_USAGE_USED" "SYSTEM_CPU_GUEST" "SYSTEM_CPU_IOWAIT" "SYSTEM_CPU_IRQ" "SYSTEM_CPU_KERNEL" "SYSTEM_CPU_NICE" "SYSTEM_CPU_SOFTIRQ" "SYSTEM_CPU_STEAL" "SYSTEM_CPU_USER" "SYSTEM_MEMORY_AVAILABLE" "SYSTEM_MEMORY_FREE" "SYSTEM_MEMORY_USED" "SYSTEM_NETWORK_IN" "SYSTEM_NETWORK_OUT" "SYSTEM_NORMALIZED_CPU_GUEST" "SYSTEM_NORMALIZED_CPU_IOWAIT" "SYSTEM_NORMALIZED_CPU_IRQ" "SYSTEM_NORMALIZED_CPU_KERNEL" "SYSTEM_NORMALIZED_CPU_NICE" "SYSTEM_NORMALIZED_CPU_SOFTIRQ" "SYSTEM_NORMALIZED_CPU_STEAL" "SYSTEM_NORMALIZED_CPU_USER" "TICKETS_AVAILABLE_READS" "TICKETS_AVAILABLE_WRITE"

One or more types of measurement to request for this MongoDB process. If omitted, the resource returns all measurements. To specify multiple values for m, repeat the m parameter for each value. Specify measurements that apply to the specified host. MongoDB Cloud returns an error if you specified any invalid measurements.

period
string <date-time> ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Date and time that indicates how far in the past to query. You can't set this value with start and end in the same request. This parameter expresses its value in the ISO 8601 duration format in UTC

Responses

Response samples

Content type
application/json
{ }

Download Logs for One Multi-Cloud Cluster Host in One Project

Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Data Access Read Write roles. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

hostName
required
string

Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.

logName
required
string
Enum: "mongodb" "mongos" "mongodb-audit-log" "mongos-audit-log"

Human-readable label of the log file that you want to return. You can return audit logs only if you enable Database Auditing for the specified project.

query Parameters
endDate
number >= 1199145600

Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.

startDate
number >= 1199145600

Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Multi-Cloud Clusters

Returns, adds, edits, or removes multi-cloud clusters.

Return All Multi-Cloud Clusters from One Project

Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes multi-cloud clusters. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "links": [ ],
  • "results": [
    ],
  • "totalCount": 0
}

Create One Multi-Cloud Cluster from One Project

Creates one cluster in the specific project. Clusters contain a group of hosts that maintain the same data set. This resource can create multi-cloud clusters. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Cluster to create in the specific project.

backupEnabled
boolean
Default: false

Flag that indicates whether the cluster can perform backups. If set to true, the cluster can perform backups. You must set this value to true for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to false, the cluster doesn't use backups.

object (MongoDB Connector for Business Intelligence Settings)

Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.

MongoDB Connector for Business Intelligence
clusterType
string
Enum: "REPLICASET" "SHARDED" "GEOSHARDED"

Configuration of nodes that comprise the cluster.
diskSizeGB
number [ 10 .. 4096 ]

Storage capacity that the host's root volume possesses expressed in gigabytes. Increase this number to add capacity. MongoDB Cloud requires this parameter if you set replicationSpecs. If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.

encryptionAtRestProvider
string
Enum: "AWS" "AZURE" "GCP" "NONE"

Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize setting must be M10 or higher and "backupEnabled" : false or omitted entirely.

Encryption at Rest using Customer Key Management
Array of objects (Component Label) [ 1 .. 255 ] characters

Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.

mongoDBMajorVersion
string
Default: "5.0"
Enum: "4.0" "4.2" "4.4" "5.0"

Major MongoDB version of the cluster. MongoDB Cloud deploys the cluster with the latest stable release of the specified version.

name
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the advanced cluster.
pitEnabled
boolean

Flag that indicates whether the cluster uses continuous cloud backups.

Continuous Cloud Backups
Array of objects (Replication Specifications)

List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global replica sets and sharded clusters, this array has one object representing where your clusters nodes deploy.

rootCertType
string
Default: "ISRGROOTX1"
Value: "ISRGROOTX1"

Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.

versionReleaseSystem
string
Default: "LTS"
Enum: "CONTINUOUS" "LTS"

Method by which the cluster maintains the MongoDB versions. If value is CONTINUOUS, you must not specify mongoDBMajorVersion.

Responses

Request samples

Content type
application/json
{
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "diskSizeGB": 10,
  • "encryptionAtRestProvider": "AWS",
  • "labels": [
    ],
  • "mongoDBMajorVersion": "4.0",
  • "name": "string",
  • "pitEnabled": true,
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "versionReleaseSystem": "CONTINUOUS"
}

Response samples

Content type
application/json
{
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskSizeGB": 10,
  • "encryptionAtRestProvider": "AWS",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "6492cb3770e674ece4e89b41",
  • "labels": [
    ],
  • "links": [ ],
  • "mongoDBMajorVersion": "4.0",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "stateName": "CREATING",
  • "versionReleaseSystem": "CONTINUOUS"
}

Remove One Multi-Cloud Cluster from One Project

Removes one cluster with advanced features from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Multi-Cloud Cluster from One Project

Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes multi-cloud clusters. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies this advanced cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskSizeGB": 10,
  • "encryptionAtRestProvider": "AWS",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "6492cb3770e674ece4e89b41",
  • "labels": [
    ],
  • "links": [ ],
  • "mongoDBMajorVersion": "4.0",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "stateName": "CREATING",
  • "versionReleaseSystem": "CONTINUOUS"
}

Modify One Multi-Cloud Cluster from One Project

Updates the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can update multi-cloud clusters. To use this resource, the requesting API Key must have the Project Cluster Manager role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the advanced cluster to modify.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Cluster to update in the specified project.

backupEnabled
boolean
Default: false

Flag that indicates whether the cluster can perform backups. If set to true, the cluster can perform backups. You must set this value to true for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to false, the cluster doesn't use backups.

object (MongoDB Connector for Business Intelligence Settings)

Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.

MongoDB Connector for Business Intelligence
clusterType
string
Enum: "REPLICASET" "SHARDED" "GEOSHARDED"

Configuration of nodes that comprise the cluster.
diskSizeGB
number [ 10 .. 4096 ]

Storage capacity that the host's root volume possesses expressed in gigabytes. Increase this number to add capacity. MongoDB Cloud requires this parameter if you set replicationSpecs. If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.

encryptionAtRestProvider
string
Enum: "AWS" "AZURE" "GCP" "NONE"

Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize setting must be M10 or higher and "backupEnabled" : false or omitted entirely.

Encryption at Rest using Customer Key Management
Array of objects (Component Label) [ 1 .. 255 ] characters

Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.

mongoDBMajorVersion
string
Default: "5.0"
Enum: "4.0" "4.2" "4.4" "5.0"

Major MongoDB version of the cluster. MongoDB Cloud deploys the cluster with the latest stable release of the specified version.

name
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the advanced cluster.
pitEnabled
boolean

Flag that indicates whether the cluster uses continuous cloud backups.

Continuous Cloud Backups
Array of objects (Replication Specifications)

List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global replica sets and sharded clusters, this array has one object representing where your clusters nodes deploy.

rootCertType
string
Default: "ISRGROOTX1"
Value: "ISRGROOTX1"

Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.

versionReleaseSystem
string
Default: "LTS"
Enum: "CONTINUOUS" "LTS"

Method by which the cluster maintains the MongoDB versions. If value is CONTINUOUS, you must not specify mongoDBMajorVersion.

Responses

Request samples

Content type
application/json
{
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "diskSizeGB": 10,
  • "encryptionAtRestProvider": "AWS",
  • "labels": [
    ],
  • "mongoDBMajorVersion": "4.0",
  • "name": "string",
  • "pitEnabled": true,
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "versionReleaseSystem": "CONTINUOUS"
}

Response samples

Content type
application/json
{
  • "backupEnabled": false,
  • "biConnector": {
    },
  • "clusterType": "REPLICASET",
  • "connectionStrings": {
    },
  • "createDate": "2019-08-24T14:15:22Z",
  • "diskSizeGB": 10,
  • "encryptionAtRestProvider": "AWS",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "6492cb3770e674ece4e89b41",
  • "labels": [
    ],
  • "links": [ ],
  • "mongoDBMajorVersion": "4.0",
  • "mongoDBVersion": "string",
  • "name": "string",
  • "paused": true,
  • "pitEnabled": true,
  • "replicationSpecs": [
    ],
  • "rootCertType": "ISRGROOTX1",
  • "stateName": "CREATING",
  • "versionReleaseSystem": "CONTINUOUS"
}

Test Failover for One Multi-Cloud Cluster

Starts a failover test for the specified cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster's primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. To use this resource, the requesting API Key must have the Project Cluster Manager role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "parameters": [
    ],
  • "reason": "Unauthorized"
}

Network Peering

Returns, adds, edits, and removes network peering containers and peering connections.

Verify Connect via Peering Only Mode for One Project Deprecated

Verifies if someone set the specified project to Connect via Peering Only mode. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

Changes to Connection Strings
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "enabled": true
}

Disable Connect via Peering Only Mode for One Project Deprecated

Disables Connect via Peering Only mode for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

Changes to Connection Strings
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Disables Connect via Peering Only mode for the specified project.

enabled
required
boolean

Flag that indicates whether someone enabled Connect via Peering Only mode for the specified project.

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "enabled": true
}

Network Peering Connections

Returns, adds, edits, and removes network peering connections.

Return All Network Peering Connections in One Project

Returns details about all network peering connections in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

providerName
string
Default: "AWS"
Enum: "AWS" "AZURE" "GCP"

Cloud service provider to use for this VPC peering connection.

Responses

Response samples

Content type
application/json
Example
{ }

Create One New Network Peering Connection

Creates one new network peering connection in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

Azure Network Peering Prerequisites
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Create one network peering connection.

containerId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.

providerName
required
string

Cloud service provider that determines the needed settings to configure the network connection for a virtual private connection.

accepterRegionName
required
string

Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns null if your VPC and the MongoDB Cloud VPC reside in the same region.

awsAccountId
required
string = 12 characters ^[0-9]{12}$

Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC.

routeTableCidrBlock
required
string^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...

Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC.

vpcId
required
string >= 5 characters ^vpc-[0-9a-f]{17}$

Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC.

Responses

Request samples

Content type
application/json
Example
{
  • "containerId": "2f3ed24096c4b70db8993cb7",
  • "providerName": "AWS",
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "routeTableCidrBlock": "string",
  • "vpcId": "string"
}

Response samples

Content type
application/json
Example
{
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "connectionId": "string",
  • "containerId": "2f3ed24096c4b70db8993cb7",
  • "errorStateName": "EXPIRED",
  • "id": "f29c6d03c5ca80634eeba63b",
  • "routeTableCidrBlock": "string",
  • "statusName": "AVAILABLE",
  • "vpcId": "string"
}

Remove One Existing Network Peering Connection

Removes one network peering connection in the specified project. If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

peerId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  • "error": 404,
  • "errorCode": "RESOURCE_NOT_FOUND",
  • "parameters": [
    ],
  • "reason": "Not Found"
}

Return One Network Peering Connection in One Project

Returns details about one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

peerId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
Example
{
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "connectionId": "string",
  • "containerId": "2f3ed24096c4b70db8993cb7",
  • "errorStateName": "EXPIRED",
  • "id": "f29c6d03c5ca80634eeba63b",
  • "routeTableCidrBlock": "string",
  • "statusName": "AVAILABLE",
  • "vpcId": "string"
}

Update One New Network Peering Connection

Updates one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

peerId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Modify one network peering connection.

containerId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.

providerName
required
string

Cloud service provider that determines the needed settings to configure the network connection for a virtual private connection.

accepterRegionName
required
string

Amazon Web Services (AWS) region where the Virtual Peering Connection (VPC) that you peered with the MongoDB Cloud VPC resides. The resource returns null if your VPC and the MongoDB Cloud VPC reside in the same region.

awsAccountId
required
string = 12 characters ^[0-9]{12}$

Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC.

routeTableCidrBlock
required
string^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...

Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC.

vpcId
required
string >= 5 characters ^vpc-[0-9a-f]{17}$

Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC.

Responses

Request samples

Content type
application/json
Example
{
  • "containerId": "2f3ed24096c4b70db8993cb7",
  • "providerName": "AWS",
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "routeTableCidrBlock": "string",
  • "vpcId": "string"
}

Response samples

Content type
application/json
Example
{
  • "accepterRegionName": "string",
  • "awsAccountId": "stringstring",
  • "connectionId": "string",
  • "containerId": "2f3ed24096c4b70db8993cb7",
  • "errorStateName": "EXPIRED",
  • "id": "f29c6d03c5ca80634eeba63b",
  • "routeTableCidrBlock": "string",
  • "statusName": "AVAILABLE",
  • "vpcId": "string"
}

Network Peering Containers

Returns, adds, edits, and removes network peering containers.

Return All Network Peering Containers in One Project for One Cloud Provider

Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

providerName
required
string
Default: "AWS"
Enum: "AWS" "AZURE" "GCP"

Cloud service provider that serves the desired network peering containers.

Responses

Response samples

Content type
application/json
{ }

Create One New Network Peering Container

Creates one new network peering container in the specified project. MongoDB Cloud can deploy Network Peering connections in a network peering container. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Creates one new network peering container in the specified project.

providerName
string
Default: "AWS"

Cloud service provider that serves the requested network peering containers.

atlasCidrBlock
string^((([0-9]{1,3}\.){3}[0-9]{1,3})|([\:]{0,2}([0...

IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.

These CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the /24 and /21 ranges.

To modify the CIDR block, the target project cannot have:

  • Any M10 or greater clusters
  • Any other VPC peering connections

You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.

Example: A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of /24 equals 27 three-node replica sets.

regionName
required
string
Enum: "US_EAST_1" "US_EAST_2" "US_WEST_1" "US_WEST_2" "CA_CENTRAL_1" "EU_NORTH_1" "EU_WEST_1" "EU_WEST_2" "EU_WEST_3" "EU_CENTRAL_1" "SA_EAST_1" "AP_EAST_1" "AP_SOUTHEAST_2" "AP_SOUTHEAST_3" "AP_NORTHEAST_1" "AP_NORTHEAST_2" "AP_NORTHEAST_3" "AP_SOUTHEAST_1" "AP_SOUTH_1" "CN_NORTH_1" "CN_NORTHWEST_1" "ME_SOUTH_1" "AF_SOUTH_1" "EU_SOUTH_1" "GLOBAL" "US_GOV_WEST_1" "US_GOV_EAST_1"

Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container.

Responses

Request samples

Content type
application/json
Example
{
  • "providerName": "AWS",
  • "atlasCidrBlock": "string",
  • "regionName": "US_EAST_1"
}

Response samples

Content type
application/json
Example
{
  • "id": "2f3ed24096c4b70db8993cb7",
  • "providerName": "AWS",
  • "provisioned": true,
  • "atlasCidrBlock": "string",
  • "regionName": "US_EAST_1",
  • "vpcId": "vpc-b555d3b0d9cb783b0"
}

Return All Network Peering Containers in One Project

Returns details about all network peering containers in the specified project. Network peering containers contain network peering connections. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Remove One Network Peering Container

Removes one network peering container in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

containerId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 2f3ed24096c4b70db8993cb7

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Network Peering Container

Returns details about one network peering container in one specified project. Network peering containers contain network peering connections. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

containerId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 2f3ed24096c4b70db8993cb7

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "2f3ed24096c4b70db8993cb7",
  • "providerName": "AWS",
  • "provisioned": true,
  • "atlasCidrBlock": "string",
  • "regionName": "US_EAST_1",
  • "vpcId": "vpc-b555d3b0d9cb783b0"
}

Update One Network Peering Container

Updates the network details and labels of one specified network peering container in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

containerId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 2f3ed24096c4b70db8993cb7

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Updates the network details and labels of one specified network peering container in the specified project.

providerName
string
Default: "AWS"

Cloud service provider that serves the requested network peering containers.

atlasCidrBlock
string^((([0-9]{1,3}\.){3}[0-9]{1,3})|([\:]{0,2}([0...

IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.

These CIDR blocks must fall within the ranges reserved per RFC 1918. AWS and Azure further limit the block to between the /24 and /21 ranges.

To modify the CIDR block, the target project cannot have:

  • Any M10 or greater clusters
  • Any other VPC peering connections

You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.

Example: A project in an Amazon Web Services (AWS) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of /24 equals 27 three-node replica sets.

regionName
required
string
Enum: "US_EAST_1" "US_EAST_2" "US_WEST_1" "US_WEST_2" "CA_CENTRAL_1" "EU_NORTH_1" "EU_WEST_1" "EU_WEST_2" "EU_WEST_3" "EU_CENTRAL_1" "SA_EAST_1" "AP_EAST_1" "AP_SOUTHEAST_2" "AP_SOUTHEAST_3" "AP_NORTHEAST_1" "AP_NORTHEAST_2" "AP_NORTHEAST_3" "AP_SOUTHEAST_1" "AP_SOUTH_1" "CN_NORTH_1" "CN_NORTHWEST_1" "ME_SOUTH_1" "AF_SOUTH_1" "EU_SOUTH_1" "GLOBAL" "US_GOV_WEST_1" "US_GOV_EAST_1"

Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container.

Responses

Request samples

Content type
application/json
Example
{
  • "providerName": "AWS",
  • "atlasCidrBlock": "string",
  • "regionName": "US_EAST_1"
}

Response samples

Content type
application/json
Example
{
  • "id": "2f3ed24096c4b70db8993cb7",
  • "providerName": "AWS",
  • "provisioned": true,
  • "atlasCidrBlock": "string",
  • "regionName": "US_EAST_1",
  • "vpcId": "vpc-b555d3b0d9cb783b0"
}

Online Archive

Returns, adds, edits, or removes an online archive.

Return All Online Archives for One Cluster

Returns details of all online archives. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

Online Archive
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Create One Online Archive

Creates one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.

Online Archive
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Creates one online archive.

collName
string

Human-readable label that identifies the collection for which you created the online archive.

collectionType
string
Default: "STANDARD"
Enum: "STANDARD" "TIMESERIES"

Classification of MongoDB database collection that you want to return.

If you set this parameter to TIMESERIES, set "criteria.type" : "date" and "criteria.dateFormat" : "ISODATE".

required
object (CriteriaView)

Rules by which MongoDB MongoDB Cloud archives data.

Use the criteria.type field to choose how MongoDB Cloud selects data to archive. Choose data using the age of the data or a MongoDB query. "criteria.type": "DATE" selects documents to archive based on a date. "criteria.type": "CUSTOM" selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support "criteria.type": "CUSTOM" when "collectionType": "TIMESERIES".

dbName
string

Human-readable label of the database that contains the collection that contains the online archive.

Array of objects (Online Archive Partition) non-empty

List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify up to two parameters that you frequently query. Any queries that don't use these parameters result in a full collection scan of all archived documents. This takes more time and increase your costs.

object (Online Archive Schedule)

Regular frequency and duration when archiving process occurs.

Responses

Request samples

Content type
application/json
{
  • "collName": "string",
  • "collectionType": "STANDARD",
  • "criteria": {
    },
  • "dbName": "string",
  • "partitionFields": [
    ],
  • "schedule": {
    }
}

Response samples

Content type
application/json
{
  • "clusterName": "string",
  • "collName": "string",
  • "collectionType": "STANDARD",
  • "criteria": {
    },
  • "dbName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "1f0df9ed79cfc99dbcc6f5d8",
  • "partitionFields": [
    ],
  • "schedule": {
    },
  • "state": "PENDING"
}

Download Online Archive Query Logs

Downloads query logs for the specified online archive. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. This resource doesn't require the API Key to have an Access List.

Online Archive
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive.

query Parameters
startDate
number >= 1199145600
Example: startDate=1636481348

Date and time that specifies the starting point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the UNIX epoch.

endDate
number >= 1199145600
Example: endDate=1636481348

Date and time that specifies the end point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the UNIX epoch.

archiveOnly
boolean
Default: false

Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.

Request Body schema: application/json

Downloads query logs for the specified online archive.

collName
string

Human-readable label that identifies the collection for which you created the online archive.

collectionType
string
Default: "STANDARD"
Enum: "STANDARD" "TIMESERIES"

Classification of MongoDB database collection that you want to return.

If you set this parameter to TIMESERIES, set "criteria.type" : "date" and "criteria.dateFormat" : "ISODATE".

required
object (CriteriaView)

Rules by which MongoDB MongoDB Cloud archives data.

Use the criteria.type field to choose how MongoDB Cloud selects data to archive. Choose data using the age of the data or a MongoDB query. "criteria.type": "DATE" selects documents to archive based on a date. "criteria.type": "CUSTOM" selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support "criteria.type": "CUSTOM" when "collectionType": "TIMESERIES".

dbName
string

Human-readable label of the database that contains the collection that contains the online archive.

Array of objects (Online Archive Partition) non-empty

List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify up to two parameters that you frequently query. Any queries that don't use these parameters result in a full collection scan of all archived documents. This takes more time and increase your costs.

object (Online Archive Schedule)

Regular frequency and duration when archiving process occurs.

Responses

Request samples

Content type
application/json
{
  • "collName": "string",
  • "collectionType": "STANDARD",
  • "criteria": {
    },
  • "dbName": "string",
  • "partitionFields": [
    ],
  • "schedule": {
    }
}

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Remove One Online Archive

Removes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.

Online Archive
path Parameters
archiveId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the online archive to delete.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "parameters": [
    ],
  • "reason": "Unauthorized"
}

Return One Online Archive

Returns one online archive for one cluster. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

Online Archive
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

archiveId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the online archive to return.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "clusterName": "string",
  • "collName": "string",
  • "collectionType": "STANDARD",
  • "criteria": {
    },
  • "dbName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "1f0df9ed79cfc99dbcc6f5d8",
  • "partitionFields": [
    ],
  • "schedule": {
    },
  • "state": "PENDING"
}

Update One Online Archive

Updates, pauses, or resumes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.

Online Archive
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

archiveId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the online archive to update.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Updates, pauses, or resumes one online archive.

collName
string

Human-readable label that identifies the collection for which you created the online archive.

collectionType
string
Default: "STANDARD"
Enum: "STANDARD" "TIMESERIES"

Classification of MongoDB database collection that you want to return.

If you set this parameter to TIMESERIES, set "criteria.type" : "date" and "criteria.dateFormat" : "ISODATE".

required
object (CriteriaView)

Rules by which MongoDB MongoDB Cloud archives data.

Use the criteria.type field to choose how MongoDB Cloud selects data to archive. Choose data using the age of the data or a MongoDB query. "criteria.type": "DATE" selects documents to archive based on a date. "criteria.type": "CUSTOM" selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support "criteria.type": "CUSTOM" when "collectionType": "TIMESERIES".

dbName
string

Human-readable label of the database that contains the collection that contains the online archive.

Array of objects (Online Archive Partition) non-empty

List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify up to two parameters that you frequently query. Any queries that don't use these parameters result in a full collection scan of all archived documents. This takes more time and increase your costs.

object (Online Archive Schedule)

Regular frequency and duration when archiving process occurs.

Responses

Request samples

Content type
application/json
{
  • "collName": "string",
  • "collectionType": "STANDARD",
  • "criteria": {
    },
  • "dbName": "string",
  • "partitionFields": [
    ],
  • "schedule": {
    }
}

Response samples

Content type
application/json
{
  • "clusterName": "string",
  • "collName": "string",
  • "collectionType": "STANDARD",
  • "criteria": {
    },
  • "dbName": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "1f0df9ed79cfc99dbcc6f5d8",
  • "partitionFields": [
    ],
  • "schedule": {
    },
  • "state": "PENDING"
}

Organizations

Returns, adds, and edits organizational units in MongoDB Cloud.

Return All Organizations

Returns all organizations to which you belong. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

name
string

Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name.

Responses

Response samples

Content type
application/json
{ }

Remove One Organization

Removes one specified organization. MongoDB Cloud imposes the following limits on this resource:

  • Organizations with active projects cannot be removed.
  • All projects in the organization must be removed before you can remove the organization. To use this resource, the requesting API Key must have the Organization Owner role. This resource doesn't require the API Key to have an Access List.
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Organization

Returns one organization to which the requesting API key has access. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Rename One Organization

Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Details to update on the specified organization.

name
required
string [ 1 .. 64 ] characters ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

Human-readable label that identifies the organization.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{ }

Return Federation Settings for One Organization

Returns information about the federation settings for the specified organization. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "federatedDomains": [
    ],
  • "hasRoleMappings": true,
  • "id": "55fa922fb343282757d9554e",
  • "identityProviderId": "c2777a9eca931f29fc2f",
  • "identityProviderStatus": "string"
}

Return One or More Projects in One Organization

Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to:

  • Isolate different environments, such as development, test, or production environments, from each other.
  • Associate different MongoDB Cloud users or teams with different environments, or give different permission to MongoDB Cloud users in different environments.
  • Maintain separate cluster security configurations.
  • Create different alert settings.

To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

name
string

Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name.

Responses

Response samples

Content type
application/json
{ }

Return All Organization Invitations

Returns all pending invitations to the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

username
string <email> ^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$...

Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations.

Responses

Response samples

Content type
application/json
{ }

Update One Organization Invitation

Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the username of the invited user. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Updates the details of one pending invitation to the specified organization.

roles
Array of strings unique
Items Enum: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY"

One or more organization or project level roles to assign to the MongoDB Cloud user.

teamIds
Array of strings[ items = 24 characters ^([a-f0-9]{24})$ ]

List of teams to which you want to invite the desired MongoDB Cloud user.

username
string <email> ^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$...

Email address that belongs to the desired MongoDB Cloud user.

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

Response samples

Content type
application/json
{ }

Invite One MongoDB Cloud User to Join One Atlas Organization

Invites one MongoDB Cloud user to join the specified organization. The user must accept the invitation to access information within the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Invites one MongoDB Cloud user to join the specified organization.

roles
Array of strings unique
Items Enum: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY"

One or more organization or project level roles to assign to the MongoDB Cloud user.

teamIds
Array of strings[ items = 24 characters ^([a-f0-9]{24})$ ]

List of teams to which you want to invite the desired MongoDB Cloud user.

username
string <email> ^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$...

Email address that belongs to the desired MongoDB Cloud user.

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ],
  • "teamIds": [
    ],
  • "username": "user@example.com"
}

Response samples

Content type
application/json
{ }

Cancel One Organization Invitation

Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

invitationId
required
string

Unique 24-hexadecimal digit string that identifies the invitation.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Organization Invitation

Returns the details of one pending invitation to the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

invitationId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the invitation.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{ }

Update One Organization Invitation by Invitation ID

Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the unique identification string for that invitation. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

invitationId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the invitation.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Updates the details of one pending invitation to the specified organization.

roles
Array of strings unique
Items Enum: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY"

One or more organization or project level roles to assign to the MongoDB Cloud user.

teamIds
Array of strings[ items = 24 characters ^([a-f0-9]{24})$ ]

List of teams to which you want to invite the desired MongoDB Cloud user.

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ],
  • "teamIds": [
    ]
}

Response samples

Content type
application/json
{
  • "roles": [
    ],
  • "teamIds": [
    ]
}

Return All MongoDB Cloud Users in One Organization

Returns details about the MongoDB Cloud users associated with the specified organization. Each MongoDB Cloud user returned must belong to the specified organization or to a project within the specified organization. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Performance Advisor

Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds.

Return All Namespaces for One Host

Returns up to 20 namespaces for collections experiencing slow queries on the specified host. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

processId
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...

Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

duration
number

Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.

  • If you don't specify the since parameter, the endpoint returns data covering the duration before the current time.
  • If you specify neither the duration nor since parameters, the endpoint returns data from the previous 24 hours.
since
number >= 1199145600

Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.

  • If you don't specify the duration parameter, the endpoint returns data covering from the since value and the current time.
  • If you specify neither the duration nor the since parameters, the endpoint returns data from the previous 24 hours.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return Slow Queries

Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

processId
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...

Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

duration
number

Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.

  • If you don't specify the since parameter, the endpoint returns data covering the duration before the current time.
  • If you specify neither the duration nor since parameters, the endpoint returns data from the previous 24 hours.
namespaces
Array of strings

Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as .: <database>.<collection>. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (&) between each namespace. Omit this parameter to return results for all namespaces.

nLogs
number [ 0 .. 20000 ]
Default: 20000

Maximum number of lines from the log to return.
since
number >= 1199145600

Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.

  • If you don't specify the duration parameter, the endpoint returns data covering from the since value and the current time.
  • If you specify neither the duration nor the since parameters, the endpoint returns data from the previous 24 hours.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return Suggested Indexes

Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

processId
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...

Combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

duration
number

Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.

  • If you don't specify the since parameter, the endpoint returns data covering the duration before the current time.
  • If you specify neither the duration nor since parameters, the endpoint returns data from the previous 24 hours.
namespaces
Array of strings

Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as .: <database>.<collection>. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (&) between each namespace. Omit this parameter to return results for all namespaces.

nExamples
number
Default: 5

Maximum number of example queries that benefit from the suggested index.

nIndexes
number

Number that indicates the maximum indexes to suggest.
since
number

Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.

  • If you don't specify the duration parameter, the endpoint returns data covering from the since value and the current time.
  • If you specify neither the duration nor the since parameters, the endpoint returns data from the previous 24 hours.

Responses

Response samples

Content type
application/json
{
  • "shapes": [
    ],
  • "suggestedIndexes": [
    ]
}

Return All Namespaces for One Host

Returns up to 20 namespaces for collections experiencing slow queries on the specified host. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

hostId
required
string^([a-f0-9]{24})$

Unique identifier of the host for the MongoDB process.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

duration
number

Length of time expressed in milliseconds during which the query finds suggested indexes among the managed namespaces in the cluster.

since
number^([0-9]{10,})$

Timestamp in the number of seconds that have elapsed since the UNIX epoch from which the query retrieves the suggested indexes.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return Slow Queries

Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

hostId
required
string^([a-f0-9]{24})$

Unique identifier of the host for the MongoDB process.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

duration
number

Length of time expressed in milliseconds during which the query finds suggested indexes among the managed namespaces in the cluster.

namespaces
Array of strings

Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as .: <database>.<collection>. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (&) between each namespace. Omit this parameter to return results for all namespaces.

nLogs
number [ 0 .. 20000 ] ^[0-9]+$
Default: 20000

Maximum number of lines from the log to return.
since
number^([0-9]{10,})$

Timestamp in the number of seconds that have elapsed since the UNIX epoch from which the query retrieves the suggested indexes.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Return Suggested Indexes

Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

hostId
required
string^([a-f0-9]{24})$

Unique identifier of the host for the MongoDB process.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

duration
number

Length of time expressed in milliseconds during which the query finds suggested indexes among the managed namespaces in the cluster.

namespaces
Array of strings

Namespaces from which to retrieve suggested indexes. A namespace consists of one database and one collection resource written as .: <database>.<collection>. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (&) between each namespace. Omit this parameter to return results for all namespaces.

nExamples
number
Default: 5

Maximum number of example queries that benefit from the suggested index.

nIndexes
number

Number that indicates the maximum indexes to suggest.
since
number

Timestamp in the number of seconds that have elapsed since the UNIX epoch from which the query retrieves the suggested indexes.

Responses

Response samples

Content type
application/json
{
  • "shapes": [
    ],
  • "suggestedIndexes": [
    ]
}

Disable Managed Slow Operation Threshold

Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "parameters": [
    ],
  • "reason": "Unauthorized"
}

Enable Managed Slow Operation Threshold

Enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. To use this resource, the requesting API Key must have the Project Owner role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "parameters": [
    ],
  • "reason": "Unauthorized"
}

Private Endpoint Services

Returns, adds, edits, and removes private endpoint services.

Create One Private Endpoint Service for One Provider

Creates one private resource service for the specified cloud service provider. This cloud service provider manages the private resource service for the project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Creates one private resource service for the specified cloud service provider.

providerName
required
string
Enum: "AWS" "AZURE" "GCP"

Human-readable label that identifies the cloud service provider for which you want to create the private endpoint service.

region
required
string

Cloud provider region in which you want to create the private endpoint service. Regions accepted as values differ for Amazon Web Services, Google Cloud Platform, and Microsoft Azure.

Responses

Request samples

Content type
application/json
{
  • "providerName": "AWS",
  • "region": "string"
}

Response samples

Content type
application/json
Example
{
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "id": "3a876d84705fbf5833488cde",
  • "interfaceEndpoints": [
    ],
  • "regionName": "string",
  • "status": "AVAILABLE"
}

Return Regionalized Private Endpoint Status

Checks whether each region in the specified cloud service provider can create multiple private resources per region. The cloud service provider manages the private resource for the project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "enabled": true
}

Toggle Regionalized Private Endpoint Status

Enables or disables the ability can create multiple private resources per region in all cloud service providers in one project. The cloud service provider manages the private resource for the project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Enables or disables the ability can create multiple private resources per region in all cloud service providers in one project.

enabled
required
boolean

Flag that indicates whether someone enabled the regionalized private endpoint setting for the specified project.

  • Set this value to true to enable regionalized private endpoints. This allows you to create more than one private endpoint in a cloud provider region. You need to enable this setting to connect to multi-region and global MongoDB Cloud sharded clusters. Enabling regionalized private endpoints introduces the following limitations:

    • Your applications must use the new connection strings for existing multi-region and global sharded clusters. This might cause downtime.

    • Your MongoDB Cloud project can't contain replica sets nor can you create new replica sets in this project.

    • You can't disable this setting if you have:

      • more than one private endpoint in more than one region
      • more than one private endpoint in one region and one private endpoint in one or more regions.

  • Set this value to false to disable regionalized private endpoints.

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "enabled": true
}

Return All Private Endpoint Services for One Provider

Returns the name, interfaces, and state of all private resource services for the specified cloud service provider. This cloud service provider manages the private resource service for the project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

cloudProvider
required
string
Default: "AWS"
Enum: "AWS" "AZURE" "GCP"

Cloud service provider that manages this private endpoint service.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
Example
{ }

Remove One Private Endpoint Service for One Provider

Removes one private resource service from the specified project. This cloud service provider manages the private resource service that belongs to the project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

cloudProvider
required
string
Default: "AWS"
Enum: "AWS" "AZURE" "GCP"

Cloud service provider that manages this private endpoint service.

endpointServiceId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Private Endpoint Service for One Provider

Returns the name, interfaces, and state of the specified private resource service from one project. The cloud service provider hosted this private resource service that belongs to the project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

cloudProvider
required
string
Default: "AWS"
Enum: "AWS" "AZURE" "GCP"

Cloud service provider that manages this private endpoint service.

endpointServiceId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
Example
{
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "id": "3a876d84705fbf5833488cde",
  • "interfaceEndpoints": [
    ],
  • "regionName": "string",
  • "status": "AVAILABLE"
}

Create One Private Endpoint for One Provider

Creates one private resource in the specified private resource service hosted from one cloud service provider. This cloud service provider manages the private resource service for the project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

cloudProvider
required
string
Default: "AWS"
Enum: "AWS" "AZURE" "GCP"

Cloud service provider that manages this private endpoint.
endpointServiceId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Creates one private resource endpoint for the specified cloud service provider.

One of
id
string^(vpce-[0-9a-f]{17}|\/subscriptions\/[0-9a-f]...

Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service.

privateEndpointIPAddress
string^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...

IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.

Responses

Request samples

Content type
application/json
Example
{
  • "id": "string",
  • "privateEndpointIPAddress": "string"
}

Response samples

Content type
application/json
Example
{
  • "connectionStatus": "AVAILABLE",
  • "deleteRequested": true,
  • "errorMessage": "string",
  • "interfaceEndpointId": "b55c6e799a3f084e9972f874"
}

Remove One Private Endpoint for One Provider

Removes one private resource from the specified project. This cloud service provider manages the private resource service that manages the private resource that belongs to the project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

cloudProvider
required
string
Default: "AWS"
Enum: "AWS" "AZURE" "GCP"

Cloud service provider that manages this private endpoint.
endpointId
required
string^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF]...

Unique string that identifies the private endpoint you want to delete. The format of the endpointId parameter differs for AWS and Azure. You must URL encode the endpointId for Azure private endpoints.

endpointServiceId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Private Endpoint for One Provider

Returns the connection state of the specified private resource. The private resource service manages this private resource which belongs to one project hosted from one cloud service provider. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

cloudProvider
required
string
Default: "AWS"
Enum: "AWS" "AZURE" "GCP"

Cloud service provider that manages this private endpoint.
endpointId
required
string^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF]...

Unique string that identifies the private endpoint you want to return. The format of the endpointId parameter differs for AWS and Azure. You must URL encode the endpointId for Azure private endpoints.

endpointServiceId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
Example
{
  • "connectionStatus": "AVAILABLE",
  • "deleteRequested": true,
  • "errorMessage": "string",
  • "interfaceEndpointId": "b55c6e799a3f084e9972f874"
}

Programmatic API Keys

Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project.

Return All Organization API Keys Assigned to One Project

Returns all organization API keys that you assigned to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

Programmatic API Keys
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
[ ]

Create and Assign One Organization API Key to One Project

Creates and assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Organization API key to be created and assigned to the specified project. This request requires a minimum of one of the two body parameters.

desc
string [ 1 .. 250 ] characters

Purpose or explanation provided when someone created this organization API key.

roles
Array of strings
Items Enum: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY"

List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization or project.

Responses

Request samples

Content type
application/json
{
  • "desc": "string",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{ }

Unassign One Organization API Key from One Project

Removes one organization API key from the specified project. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

Programmatic API Keys
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

apiUserId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Update Roles of One Organization API Key to One Project

Updates the roles of the organization API key that you specify for the project that you specify. You must specify at least one valid role for the project. The application removes any roles that you do not include in this request if they were previously set in the organization API key that you specify for the project.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Organization API Key to be updated. This request requires a minimum of one of the two body parameters.

desc
string [ 1 .. 250 ] characters

Purpose or explanation provided when someone created this organization API key.

roles
Array of strings
Items Enum: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY"

List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization or project.

Responses

Request samples

Content type
application/json
{
  • "desc": "string",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{ }

Assign One Organization API Key to One Project

Assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can then use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

apiUserId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Organization API key to be assigned to the specified project.

Array
roles
Array of strings
Items Enum: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_SEARCH_INDEX_EDITOR" "GROUP_OWNER" "GROUP_READ_ONLY" "GLOBAL_EXPERIMENT_ASSIGNMENT_USER"

List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{ }

Return All Organization API Keys

Returns all organization API keys for the specified organization. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.

Programmatic API Keys
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
[ ]

Create One Organization API Key

Creates one API key for the specified organization. An organization API key grants programmatic access to an organization. You can't use the API key to log into the console. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.

Programmatic API Keys
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Organization API Key to be created. This request requires a minimum of one of the two body parameters.

desc
string [ 1 .. 250 ] characters

Purpose or explanation provided when someone created this organization API key.

roles
Array of strings
Items Enum: "ORG_OWNER" "ORG_MEMBER" "ORG_GROUP_CREATOR" "ORG_BILLING_ADMIN" "ORG_READ_ONLY"

List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization or project.

Responses

Request samples

Content type
application/json
{
  • "desc": "string",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{ }

Remove One Organization API Key

Removes one organization API key from the specified organization. When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.

Configure Atlas API Access
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

apiUserId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies this organization API key.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "parameters": [
    ],
  • "reason": "Unauthorized"
}

Return One Organization API Key

Returns one organization API key. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the user interface. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.

Programmatic API Keys
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

apiUserId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies this organization API key that you want to update.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Update One Organization API Key

Updates one organization API key in the specified organization. The organization API keys grant programmatic access to an organization. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.

Programmatic API Keys
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

apiUserId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies this organization API key you want to update.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Organization API key to be updated. This request requires a minimum of one of the two body parameters.

desc
string [ 1 .. 250 ] characters

Purpose or explanation provided when someone created this organization API key.

Array of objects (Role Assignment)

List that contains the roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the API key.

Responses

Request samples

Content type
application/json
{
  • "desc": "string",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{ }

Return All Access List Entries for One Organization API Key

Returns all access list entries that you configured for the specified organization API key. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.

Programmatic API Keys
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

apiUserId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
[ ]

Create Access List Entries for One Organization API Key

Creates the access list entries for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role and an entry for the project access list.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

apiUserId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Access list entries to be created for the specified organization API key.

Array
cidrBlock
string^((([0-9]{1,3}\.){3}[0-9]{1,3})|([\:]{0,2}([0...

Range of network addresses that you want to add to the access list for the API key. This parameter requires the range to be expressed in classless inter-domain routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or ipAddress but not both in the same request.

ipAddress
string^((([0-9]{1,3}\.){3}[0-9]{1,3})|([\:]{0,2}([0...

Network address that you want to add to the access list for the API key. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or cidrBlock but not both in the same request.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{ }

Remove One Access List Entry for One Organization API Key

Removes the specified access list entry from the specified organization API key. Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role and an entry for the project access list.

Configure Atlas API Access
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

apiUserId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries.

ipAddress
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
Example: 192.0.2.0%2F24

One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Access List Entry for One Organization API Key

Returns one access list entry for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.

Configure Atlas API Access
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

ipAddress
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
Example: 192.0.2.0%2F24

One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.

apiUserId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
[ ]

Project IP Access List

Returns, adds, edits, and removes network access limits to database deployments in MongoDB Cloud.

Return Project IP Access List

Returns all access list entries from the specified project's IP access list. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List.

IP access list
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Add Entries to Project IP Access List

Adds one or more access list entries to the specified project. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List.

IP access list
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

One or more access list entries to add to the specified project.

Array
awsSecurityGroup
string^([0-9]*\/)?sg-([0-9]*)

Unique string of the Amazon Web Services (AWS) security group that you want to add to the project's IP access list. Your IP access list entry can be one awsSecurityGroup, one cidrBlock, or one ipAddress. You must configure Virtual Private Connection (VPC) peering for your project before you can add an AWS security group to an IP access list. You cannot set AWS security groups as temporary access list entries. Don't set this parameter if you set cidrBlock or ipAddress.

cidrBlock
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...

Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that you want to add to the project's IP access list. Your IP access list entry can be one awsSecurityGroup, one cidrBlock, or one ipAddress. Don't set this parameter if you set awsSecurityGroup or ipAddress.

comment
string <= 80 characters

Remark that explains the purpose or scope of this IP access list entry.

deleteAfterDate
string <date-time> ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Date and time after which MongoDB Cloud deletes the temporary access list entry. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. The date must be later than the current date but no later than one week after you submit this request. The resource returns this parameter if you specified an expiration date when creating this IP access list entry.

ipAddress
string^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...

IP address that you want to add to the project's IP access list. Your IP access list entry can be one awsSecurityGroup, one cidrBlock, or one ipAddress. Don't set this parameter if you set awsSecurityGroup or cidrBlock.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{ }

Remove One Entry from One Project IP Access List

Removes one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

IP access list
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

entryValue
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
Example: IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8

Access list entry that you want to remove from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (/) with its URL-encoded value (%2F). When you remove an entry from the IP access list, existing connections from the removed address or addresses may remain open for a variable amount of time. The amount of time it takes MongoDB Cloud to close the connection depends upon several factors, including:

  • how your application established the connection,
  • how MongoDB Cloud or the driver using the address behaves, and
  • which protocol (like TCP or UDP) the connection uses.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 403,
  • "errorCode": "CANNOT_CHANGE_GROUP_NAME",
  • "parameters": [
    ],
  • "reason": "Forbidden"
}

Return One Project IP Access List Entry

Returns one access list entry from the specified project's IP access list. The project's IP access list entry contains either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

IP access list
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

entryValue
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
Example: IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8

Access list entry that you want to return from the project's IP access list. This value can use one of the following: one AWS security group ID, one IP address, or one CIDR block of addresses. For CIDR blocks that use a subnet mask, replace the forward slash (/) with its URL-encoded value (%2F).

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Return Status of One Project IP Access List Entry

Returns the status of one project IP access list entry. This resource checks if the provided project IP access list entry applies to all cloud providers serving clusters from the specified project.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

entryValue
required
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
Example: IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348 or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS SG: sg-903004f8

Network address or cloud provider security construct that identifies which project access list entry to be verified.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "STATUS": "PENDING"
}

Projects

Returns, adds, and edits collections of clusters and users in MongoDB Cloud.

Return All Projects

Returns details about all projects. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this resource, the requesting API Key must have the Read Write role. This resource doesn't require the API Key to have an Access List.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Create One Project

Creates one project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this resource, the requesting API Key must have the Read Write role. This resource doesn't require the API Key to have an Access List.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

projectOwnerId
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.

Request Body schema: application/json

Creates one project.

name
required
string [ 1 .. 64 ] characters ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

Human-readable label that identifies the project included in the MongoDB Cloud organization.

orgId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.

withDefaultAlertsSettings
boolean

Flag that indicates whether to create the project with default alert settings.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "orgId": "4888442a3354817a7320eb61",
  • "withDefaultAlertsSettings": true
}

Response samples

Content type
application/json
{ }

Return One Project using Its Name

Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupName
required
string [ 1 .. 64 ] characters

Human-readable label that identifies this project.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Remove One Project

Removes the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this resource, the requesting API Key must have the Project Owner role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Project

Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Return One Project Settings

Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role. This resource does not require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "isCollectDatabaseSpecificsStatisticsEnabled": true,
  • "isDataExplorerEnabled": true,
  • "isPerformanceAdvisorEnabled": true,
  • "isRealtimePerformancePanelEnabled": true,
  • "isSchemaAdvisorEnabled": true
}

Update One Project Settings

Updates the settings of the specified project. You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting API Key must have the Project Owner role. This resource does not require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json
isCollectDatabaseSpecificsStatisticsEnabled
boolean

Flag that indicates whether to collect database-specific metrics for the specified project.

isDataExplorerEnabled
boolean

Flag that indicates whether to enable the Data Explorer for the specified project.

isPerformanceAdvisorEnabled
boolean

Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project.

isRealtimePerformancePanelEnabled
boolean

Flag that indicates whether to enable the Real Time Performance Panel for the specified project.

isSchemaAdvisorEnabled
boolean

Flag that indicates whether to enable the Schema Advisor for the specified project.

Responses

Request samples

Content type
application/json
{
  • "isCollectDatabaseSpecificsStatisticsEnabled": true,
  • "isDataExplorerEnabled": true,
  • "isPerformanceAdvisorEnabled": true,
  • "isRealtimePerformancePanelEnabled": true,
  • "isSchemaAdvisorEnabled": true
}

Response samples

Content type
application/json
{
  • "isCollectDatabaseSpecificsStatisticsEnabled": true,
  • "isDataExplorerEnabled": true,
  • "isPerformanceAdvisorEnabled": true,
  • "isRealtimePerformancePanelEnabled": true,
  • "isSchemaAdvisorEnabled": true
}

Return All Users in One Project

Returns details about all users in the specified project. Users belong to an organization. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

flattenTeams
boolean
Default: false

Flag that indicates whether the returned list should include users who belong to a team with a role in this project. You might not have assigned the individual users a role in this project. If "flattenTeams" : false, this resource returns only users with a role in the project. If "flattenTeams" : true, this resource returns both users with roles in the project and users who belong to teams with roles in the project.

includeOrgUsers
boolean
Default: false

Flag that indicates whether the returned list should include users with implicit access to the project, the Organization Owner or Organization Read Only role. You might not have assigned the individual users a role in this project. If "includeOrgUsers": false, this resource returns only users with a role in the project. If "includeOrgUsers": true, this resource returns both users with roles in the project and users who have implicit access to the project through their organization role.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Remove One User from One Project

Removes the specified user from the specified project. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

userId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal string that identifies MongoDB Cloud user you want to remove from the specified project. To return a application user's ID using their application username, use the Get All application users in One Project endpoint.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return All Project Invitations

Returns all pending invitations to the specified project. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

username
string <email> ^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$...

Email address of the user account invited to this project.

Responses

Response samples

Content type
application/json
{ }

Update One Project Invitation

Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the username of the invited user. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Updates the details of one pending invitation to the specified project.

roles
Array of strings unique
Items Enum: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

One or more organization or project level roles to assign to the MongoDB Cloud user.

username
string <email> ^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$...

Email address of the MongoDB Cloud user invited to the specified project.

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ],
  • "username": "user@example.com"
}

Response samples

Content type
application/json
{ }

Invite One MongoDB Cloud User to Join One Project

Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Request Body schema: application/json

Invites one MongoDB Cloud user to join the specified project.

roles
Array of strings unique
Items Enum: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

One or more organization or project level roles to assign to the MongoDB Cloud user.

username
string <email> ^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$...

Email address of the MongoDB Cloud user invited to the specified project.

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ],
  • "username": "user@example.com"
}

Response samples

Content type
application/json
{ }

Cancel One Project Invitation

Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

invitationId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the invitation.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint)",
  • "error": 401,
  • "errorCode": "NOT_ORG_GROUP_CREATOR",
  • "parameters": [
    ],
  • "reason": "Unauthorized"
}

Return One Project Invitation

Returns the details of one pending invitation to the specified project. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

invitationId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the invitation.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Update One Project Invitation by Invitation ID

Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the unique identification string for that invitation. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

invitationId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the invitation.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Request Body schema: application/json

Updates the details of one pending invitation to the specified project.

roles
Array of strings unique
Items Enum: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

One or more organization or project level roles to assign to the MongoDB Cloud user.

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "roles": [
    ]
}

Rolling Index

Creates one index to a database deployment in a rolling manner.

Create One Rolling Index

Creates an index on the cluster identified by its name in a rolling manner. Creating the index in this way allows index builds on one replica set member as a standalone at a time, starting with the secondary members. Creating indexes in this way requires at least one replica set election. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.

Rolling Index Builds on Replica Sets
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster on which MongoDB Cloud creates an index.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Rolling index to create on the specified cluster.

object (collation)

One or more settings that specify language-specific rules to compare strings within this index.

Collation Options
collection
required
string

Human-readable label of the collection for which MongoDB Cloud creates an index.

db
required
string

Human-readable label of the database that holds the collection on which MongoDB Cloud creates an index.

required
Array of objects[ items = 1 properties ]

List that contains one or more objects that describe the parameters that you want to index.

object (IndexOptions)

One or more settings that determine how the MongoDB Cloud creates this MongoDB index.

Index Options

Responses

Request samples

Content type
application/json
{
  • "collation": {
    },
  • "collection": "string",
  • "db": "string",
  • "keys": [
    ],
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Root

Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API.

Return the status of this MongoDB application

This resource returns information about the MongoDB application along with API key meta data.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Serverless Instances

Returns, adds, edits, and removes serverless instances.

Return All Serverless Instances from One Project

Returns details for all serverless instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Create One Serverless Instance in One Project

Creates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Create One Serverless Instance in One Project.

name
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the serverless instance.
object (Serverless_Instance_Provider_Settings)

Group of settings that configure the provisioned MongoDB serverless instance. The options available relate to the cloud service provider.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "providerSettings": {
    }
}

Response samples

Content type
application/json
{
  • "connectionStrings": {
    },
  • "createDate": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "e870889e64835532ca903154",
  • "links": [ ],
  • "mongoDBVersion": "string",
  • "name": "string",
  • "providerSettings": {
    },
  • "stateName": "CREATING"
}

Remove One Serverless Instance from One Project

Removes one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

name
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the serverless instance.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Serverless Instance from One Project

Returns details for one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

name
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the serverless instance.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "connectionStrings": {
    },
  • "createDate": "string",
  • "groupId": "32b6e34b3d91647abb20e7b8",
  • "id": "e870889e64835532ca903154",
  • "links": [ ],
  • "mongoDBVersion": "string",
  • "name": "string",
  • "providerSettings": {
    },
  • "stateName": "CREATING"
}

Update One Serverless Instance in One Project

Updates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

name
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the serverless instance.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Update One Serverless Instance in One Project.

object (ApiAtlasServerlessClusterDescriptionPatchView)

Settings that can be updated when a serverless cluster update is requested.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Serverless Private Endpoints

Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.

Set Up a Private Endpoint for a Serverless Instance Tutorial

Return All Private Endpoints for One Serverless Instance

Returns all private endpoints for one serverless instance. You must have at least the Project Read Only role for the project to successfully call this resource. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

instanceName
required
string <= 64 characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the serverless instance associated with the tenant endpoint.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create One Private Endpoint for One Serverless Instance

Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. This resource doesn't require the API Key to have an Access List.

A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance.

Set Up a Private Endpoint for a Serverless Instance Tutorial
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

instanceName
required
string <= 64 characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Request Body schema: application/json
comment
string <= 80 characters

Human-readable comment associated with the private endpoint.

Responses

Request samples

Content type
application/json
{
  • "comment": "string"
}

Response samples

Content type
application/json
Example
{
  • "_id": "76232bec98341ad1155cc244",
  • "cloudProviderEndpointId": "string",
  • "comment": "string",
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "status": "RESERVATION_REQUESTED"
}

Remove One Private Endpoint for One Serverless Instance

Remove one private endpoint from one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

instanceName
required
string <= 64 characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed.

endpointId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Private Endpoint for One Serverless Instance

Return one private endpoint for one serverless instance. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

instanceName
required
string <= 64 characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the serverless instance associated with the tenant endpoint.

endpointId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the tenant endpoint.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
Example
{
  • "_id": "76232bec98341ad1155cc244",
  • "cloudProviderEndpointId": "string",
  • "comment": "string",
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "status": "RESERVATION_REQUESTED"
}

Update One Private Endpoint for One Serverless Instance

Updates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

instanceName
required
string <= 64 characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated.

endpointId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Request Body schema: application/json
cloudProviderEndpointId
string^(vpce-[0-9a-f]{17}|\/subscriptions\/[0-9a-f]...

Unique string that identifies the private endpoint's network interface.

comment
string <= 80 characters

Human-readable comment associated with the private endpoint.
providerName
required
string

Responses

Request samples

Content type
application/json
Example
{
  • "cloudProviderEndpointId": "string",
  • "comment": "string",
  • "providerName": "AWS"
}

Response samples

Content type
application/json
Example
{
  • "_id": "76232bec98341ad1155cc244",
  • "cloudProviderEndpointId": "string",
  • "comment": "string",
  • "endpointServiceName": "string",
  • "errorMessage": "string",
  • "status": "RESERVATION_REQUESTED"
}

Shared-Tier Restore Jobs

Returns and adds restore jobs for shared-tier database deployments.

Create One Restore Job from One M2 or M5 Cluster

Restores the specified cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting API Key must have the Atlas Project Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

The restore job details.

snapshotId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the snapshot to restore.

targetDeploymentItemName
required
string [ 1 .. 64 ] characters ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

Human-readable label that identifies the cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to a cluster tier M2 or greater.

targetProjectId
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.

Responses

Request samples

Content type
application/json
{
  • "snapshotId": "78e18e587716102f711a5bca",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "ca4d8a18b96b317422974eec"
}

Response samples

Content type
application/json
{
  • "clusterName": "string",
  • "deliveryType": "DOWNLOAD",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "id": "e7cb93f480f357b5139ccf37",
  • "links": [ ],
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreFinishedDate": "2019-08-24T14:15:22Z",
  • "restoreScheduledDate": "2019-08-24T14:15:22Z",
  • "snapshotFinishedDate": "2019-08-24T14:15:22Z",
  • "snapshotId": "78e18e587716102f711a5bca",
  • "snapshotUrl": "string",
  • "status": "COMPLETED",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "ca4d8a18b96b317422974eec"
}

Return All Restore Jobs for One M2 or M5 Cluster

Returns all restore jobs for the specified M2 or M5 cluster. Restore jobs restore a cluster using a snapshot. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Return One Restore Job for One M2 or M5 Cluster

Returns the specified restore job. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

restoreId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the restore job to return.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "clusterName": "string",
  • "deliveryType": "DOWNLOAD",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "id": "e7cb93f480f357b5139ccf37",
  • "links": [ ],
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreFinishedDate": "2019-08-24T14:15:22Z",
  • "restoreScheduledDate": "2019-08-24T14:15:22Z",
  • "snapshotFinishedDate": "2019-08-24T14:15:22Z",
  • "snapshotId": "78e18e587716102f711a5bca",
  • "snapshotUrl": "string",
  • "status": "COMPLETED",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "ca4d8a18b96b317422974eec"
}

Shared-Tier Snapshots

Returns and requests to download shared-tier database deployment snapshots.

Download One M2 or M5 Cluster Snapshot

Requests one snapshot for the specified shared cluster. This resource returns a snapshotURL that you can use to download the snapshot. This snapshotURL remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Snapshot to be downloaded.

snapshotId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the snapshot to restore.

targetDeploymentItemName
required
string [ 1 .. 64 ] characters ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$

Human-readable label that identifies the cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to a cluster tier M2 or greater.

targetProjectId
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.

Responses

Request samples

Content type
application/json
{
  • "snapshotId": "78e18e587716102f711a5bca",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "ca4d8a18b96b317422974eec"
}

Response samples

Content type
application/json
{
  • "clusterName": "string",
  • "deliveryType": "DOWNLOAD",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "id": "e7cb93f480f357b5139ccf37",
  • "links": [ ],
  • "projectId": "32b6e34b3d91647abb20e7b8",
  • "restoreFinishedDate": "2019-08-24T14:15:22Z",
  • "restoreScheduledDate": "2019-08-24T14:15:22Z",
  • "snapshotFinishedDate": "2019-08-24T14:15:22Z",
  • "snapshotId": "78e18e587716102f711a5bca",
  • "snapshotUrl": "string",
  • "status": "COMPLETED",
  • "targetDeploymentItemName": "string",
  • "targetProjectId": "ca4d8a18b96b317422974eec"
}

Return All Snapshots for One M2 or M5 Cluster

Returns details for all snapshots for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Return One Snapshot for One M2 or M5 Cluster

Returns details for one snapshot for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

clusterName
required
string [ 1 .. 64 ] characters ^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...

Human-readable label that identifies the cluster.
snapshotId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the desired snapshot.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Teams

Returns, adds, edits, or removes teams.

Return All Teams in One Project

Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

Responses

Response samples

Content type
application/json
{ }

Add One or More Teams to One Project

Adds one team to the specified project. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.

Manage Organization Teams
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Team to add to the specified project.

roleNames
Array of strings unique
Items Enum: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

One or more organization- or project-level roles to assign to the MongoDB Cloud user.

teamId
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal character string that identifies the team.

Responses

Request samples

Content type
application/json
{
  • "roleNames": [
    ],
  • "teamId": "e254e4ade2206f4520d4107d"
}

Response samples

Content type
application/json
{ }

Remove One Team from One Project

Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Project User Admin role.

Manage Organization Teams
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

teamId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Update Team Roles in One Project

Updates the project roles assigned to the specified team. You can grant team roles for specific projects and grant project access roles to users in the team. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project User Admin role.

Manage Organization Teams
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

teamId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the team for which you want to update roles.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

The project roles assigned to the specified team.

roleNames
Array of strings unique
Items Enum: "GROUP_CLUSTER_MANAGER" "GROUP_DATA_ACCESS_ADMIN" "GROUP_DATA_ACCESS_READ_ONLY" "GROUP_DATA_ACCESS_READ_WRITE" "GROUP_OWNER" "GROUP_READ_ONLY"

One or more organization- or project-level roles to assign to the MongoDB Cloud user.

teamId
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal character string that identifies the team.

Responses

Request samples

Content type
application/json
{
  • "roleNames": [
    ],
  • "teamId": "e254e4ade2206f4520d4107d"
}

Response samples

Content type
application/json
{ }

Return All Teams in One Organization

Returns all teams that belong to the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.

Manage Organization Teams
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Create One Team in One Organization

Creates one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.

Manage Organization Teams
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Team that you want to create in the specified organization.

name
required
string

Human-readable label that identifies the team.
usernames
required
Array of strings

List that contains the MongoDB Cloud users in this team.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "usernames": [
    ]
}

Response samples

Content type
application/json
{ }

Return One Team using its Name

Returns one team that you identified using its human-readable name. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.

Manage Organization Teams
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

teamName
required
string

Name of the team whose information you want to return.
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Remove One Team from One Organization

Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.

Manage Organization Teams
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

teamId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the team that you want to delete.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Team using its ID

Returns one team that you identified using its unique 24-hexadecimal digit ID. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.

Manage Organization Teams
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

teamId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the team whose information you want to return.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Rename One Team

Renames one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.

Manage Organization Teams
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

teamId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the team that you want to rename.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Details to update on the specified team.

name
required
string

Human-readable label that identifies the team.
usernames
required
Array of strings

List that contains the MongoDB Cloud users in this team.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "usernames": [
    ]
}

Response samples

Content type
application/json
{ }

Return All MongoDB Cloud Users Assigned to One Team

Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.

Manage Organization Teams
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

teamId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the team whose application users you want to return.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Assign MongoDB Cloud Users from One Organization to One Team

Adds one or more MongoDB Cloud users from the specified organization to the specified team. Teams enable you to grant project access roles to MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one organization to one team. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.

Manage Organization Teams
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

teamId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

One or more MongoDB Cloud users that you want to add to the specified team.

id
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.

Responses

Request samples

Content type
application/json
{
  • "id": "887821d389de9fe084df2bdf"
}

Response samples

Content type
application/json
[ ]

Remove One MongoDB Cloud User from One Team

Removes one MongoDB Cloud user from the specified team. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.

Manage Organization Teams
path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
orgId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 4888442a3354817a7320eb61

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

teamId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies the team from which you want to remove one database application user.

userId
required
string = 24 characters ^([a-f0-9]{24})$

Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Third-Party Service Integrations

Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure.

Return All Active Third-Party Service Integrations

Returns the settings that permit integrations with all configured third-party services. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Project Monitoring Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Remove One Third-Party Service Integration

Removes the settings that permit configuring one third-party service integration. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Project Monitoring Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
integrationType
required
string
Enum: "PAGER_DUTY" "MICROSOFT_TEAMS" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "PROMETHEUS"

Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.

app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{
  • "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  • "error": 400,
  • "errorCode": "INVALID_PROVIDER",
  • "parameters": [
    ],
  • "reason": "Bad Request"
}

Return One Third-Party Service Integration

Returns the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Project Monitoring Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

integrationType
required
string
Enum: "PAGER_DUTY" "MICROSOFT_TEAMS" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "PROMETHEUS"

Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
Example
{
  • "type": "DATADOG",
  • "apiKey": "string",
  • "region": "EU"
}

Configure One Third-Party Service Integration

Adds the settings for configuring one third-party service integration. These settings apply to all databases managed in the specified MongoDB Cloud project. To use this resource, the requesting API Key must have the Project Monitoring Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
integrationType
required
string
Enum: "PAGER_DUTY" "MICROSOFT_TEAMS" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "PROMETHEUS"

Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.

app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Third-party integration configuration that you want to configure for your project.

type
string

Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.

apiKey
required
string

Key that allows MongoDB Cloud to access your Datadog account.
region
string
Default: "US"
Enum: "EU" "US" "US3" "US5"

Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API.

Responses

Request samples

Content type
application/json
Example
{
  • "type": "DATADOG",
  • "apiKey": "string",
  • "region": "EU"
}

Response samples

Content type
application/json
{ }

Update One Third-Party Service Integration

Updates the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Project Monitoring Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
integrationType
required
string
Enum: "PAGER_DUTY" "MICROSOFT_TEAMS" "SLACK" "DATADOG" "NEW_RELIC" "OPS_GENIE" "VICTOR_OPS" "WEBHOOK" "PROMETHEUS"

Human-readable label that identifies the service which you want to integrate with MongoDB Cloud.

app
required
string
Value: "atlas"

Application that handles this API resource.
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Third-party integration configuration that you want to configure for your project.

type
string

Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type.

apiKey
required
string

Key that allows MongoDB Cloud to access your Datadog account.
region
string
Default: "US"
Enum: "EU" "US" "US3" "US5"

Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API.

Responses

Request samples

Content type
application/json
Example
{
  • "type": "DATADOG",
  • "apiKey": "string",
  • "region": "EU"
}

Response samples

Content type
application/json
{ }

X.509 Authentication for Database Users

Returns, edits, and removes user-managed X.509 configurations. Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources help manage database users who authenticate using X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud do it for you. If MongoDB Cloud manages your certificates, it also manages your Certificate Authority and can generate certificates for your database users. No additional X.509 configuration is required. If you manage your certificates, you must provide a Certificate Authority and generate certificates for your database users.

Self-Managed X.509 Certificates

Return All X.509 Certificates Assigned to One MongoDB User

Returns all unexpired X.509 certificates for the specified MongoDB user. This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

username
required
string

Human-readable label that represents the MongoDB database user account whose certificates you want to return.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

includeCount
boolean
Default: true
Example: includeCount=true

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

itemsPerPage
integer [ 1 .. 500 ]
Default: 100
Example: itemsPerPage=100

Number of items that the response returns per page.
pageNum
integer >= 1
Default: 1
Example: pageNum=1

Number of the page that displays the current set of the total objects that the response returns.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Create One X.509 Certificate for One MongoDB User

Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

To get MongoDB Cloud to generate a managed certificate for a database user, set "x509Type" : "MANAGED" on the desired MongoDB Database User.

If you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA.

Self-Managed X.509
path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

username
required
string

Human-readable label that represents the MongoDB database user account for whom to create a certificate.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Generates one X.509 certificate for the specified MongoDB user.

monthsUntilExpiration
integer <int32> <= 24
Default: 3

Number of months that the certificate remains valid until it expires.

Responses

Request samples

Content type
application/json
{
  • "monthsUntilExpiration": 3
}

Response samples

Content type
application/json
{ }

Return the Current LDAP or X.509 Configuration

Returns the current LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Responses

Response samples

Content type
application/json
{ }

Edit the LDAP or X.509 Configuration

Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.

Updating this configuration triggers a rolling restart of the database.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

pretty
boolean
Default: false
Example: pretty=false

Flag that indicates whether the response body should be in the prettyprint format.

Request Body schema: application/json

Updates the LDAP configuration for the specified project.

object (Database User TLS Certificate Settings)

Settings to configure TLS Certificates for database users.
object (LDAP Security Settings)

Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details that apply to the specified project.

Responses

Request samples

Content type
application/json
{
  • "customerX509": {
    },
  • "ldap": {
    }
}

Response samples

Content type
application/json
{ }

Disable Customer-Managed X.509

Clear customer-managed X.509 settings on a project, including the uploaded Certificate Authority, disabling Self-Managed X.509.

Updating this configuration triggers a rolling restart of the database.

path Parameters
groupId
required
string = 24 characters ^([a-f0-9]{24})$
Example: 32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies your project.

query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/json
{ }